Repository navigation
DOC: Partial documentation build #10470
Description
Copy-pasted idea from @bsipocz on Slack so it doesn't get lost.
pandas has a custom option to build only one html of the docs. It would not work out of the box for astropy (and as we do care about working intersphinx links, I don't think partial docs build will ever fully work), but it nevertheless could be used as a starting point/inspiration for an astropy (practically sphinx-astropy) workaround. In case someone feel motivated to work on this:
(pycharm's rst rendering, directly running numpydoc, and the ability to parallel build addresses my local docs build needs)
EDIT: Permalink to the code mentioned is https://github.com/pandas-dev/pandas/blob/91241aec16e161623bac012349e7095c2ada1844/doc/make.py#L52
Activity
nstarman commentedon Apr 20, 2021
What's the motivation for a single html page version of the docs? Or is this a single page from the docs?
pllim commentedon Apr 20, 2021
The motivation for partial build here is to check, say, new doc fixes for a particular page, without having to wait for the whole package doc to build. If you have built the package docs before, you might have noticed that it takes a while.
However, that said, perhaps this issue is more of a wish than reality, because lots of links will break if you don't build the whole thing. 🤷
nstarman commentedon Apr 20, 2021
Ok, it's the latter. Yes! That would be very nice. Presumably all internal links would just not work, but that'd be fine for most checks. I use an ReST compiler to check basic stuff, but it can't do cross links.
LoveChauhan-18 commentedon Feb 13, 2026
Hello, I would like to contribute to this issue. Would it be possible to assign it to me?