Uh oh!
There was an error while loading. Please reload this page.
Infra: Use consistent 'make html' and 'make dirhtml' - #2968
Conversation
d8c9ee9 to
733e21dCompareUh oh!
There was an error while loading. Please reload this page.
CAM-Gerlach
left a comment
There was a problem hiding this comment.
LGTM, makes sense (I'd get confused too).
Though to be honest I don't ever actually use the Makefile (or even build.py, since it basically just wraps a limited subset of Sphinx's interface)—I just run python -m sphinx . build instead, which does exactly the same thing but gives me the full power of Sphinx's native CLI, including writing out only one specific PEP, writing to separate build dirs, passing -b -X dev to get Python-level warnings, etc. And, of course, it lets me use my Conda env and test different Sphinx and tool versions vs. the hardcoded venv.
Rosuav
commented
Jan 17, 2023
LGTM. I've only ever used the defaults but consistency is always a good thing. |
I keep forgetting what
make renderandmake pagesactually do, and to be sure need to check how theMakefilecallsbuild.pyand how that callssphinx-build.Let's add
make htmlandmake dirhtmlaliases.These are the actual Sphinx builder names, and the same
Makefiletargets are used by other Sphinx/Python projects, including CPython docs and the devguide, so we can use muscle memory.(They're also the default for new Sphinx projects.)
And then I don't think we need the old
make renderandmake pagesand can mark them as deprecated?