sphinx-autobuild
sphinx-autobuild copied to clipboard
Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a livereload enabled web server.
Coming from 359f3e6 -- I almost wrote a comment there but figured doing this over an issue has better odds of discoverability in the future. :) @AA-Turner Is there a...
I think the title is a sufficiently clear description. Let me know if more details are necessary. ### How to reproduce 1. Checkout https://github.com/pradyunsg/furo/tree/2024.04.27 2. Run `nox -s docs-live` 3....
I was wondering if it would be possible to use sphinx-autobuild also for PDF output. Since viewers like evince support reloading documents on change, it is actually just as convenient...
Hello, I use `autosummary` with basic templating to create pages for each class in a submodule. Using `s[hinx-autobuild` has definitely made my life easier! However, on making changes to the...
`sphinx-build` has a hiddenish entry point (it doesn't show up in `sphinx-build --help`) that is used for some build targets (see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/cmd/build.py#L381-L384). It's useful to be able to autobuild these,...
I'm using the autodoc sphinx plugin, so in order to work on the documentation from the docstrings in my code I would expect the following command to work: ```sh sphinx-autobuild...
# Context It is currently possible to run `pre-build` commands. In some situation, it can be interesting to run commands after sphinx-build, e.g. `tailwindcss`. # Proposal This PR adds support...
This might be related to #118, not sure. I don't really know how `sphinx-autobuild` works at the low level. Let me describe my scenario and someone more knowledgeable can decide....
See https://github.com/sphinx-doc/sphinx/pull/3938/files for the documentation, and https://github.com/sphinx-doc/sphinx/blob/master/sphinx/make_mode.py for implementation Basically `-M` is a alias for `-b` with some additional handling for other features like a `help` and LaTeX. Assuming this...
Hi :) This is an implementation for the feature requested in issue #131 This fork enables sphinx-autobuild's ignore system to leverage sphinx's `conf.py`. Sphinx's `exclude_patterns` configuration is now taken into...