Change references to build_sphinx to build_docs #3924
Conversation
…uild_sphinx in the documentation to the less cryptic-looking build_docs
embray
added
Docs
Ready-for-final-review
zzz 💤 astropy-helpers
|
One of the travis builds failed for no particular reason. We should really figure out how to get docs-only builds working in Travis, hmm... |
|
👍 from me - as you said the failure is a red herring so this is fine and I'll go ahead and merge. |
Change references to build_sphinx to build_docs
|
This wasn't supposed to be merged yet. See the note:
And the milestone: Future |
|
Not sure what to do--if others are fine with it I'll just leave it and mark it as v1.1. Otherwise if more people agree it should be held off on I can revert. I'm mostly fine either way, though I felt like it was better to wait on this. |
2 participants
Following on from astropy/astropy-helpers#161, which added an alias to the
build_sphinxcommand to simplybuild_docs, change references tobuild_sphinxin the documentation to the less cryptic-lookingbuild_docs.We shouldn't jump the gun on merging this PR yet. For one, Astropy hasn't even updated the astropy-helpers submodule to point to a version that includes this alias. And even once that happens this could be confusing for contributors working on older branches of astropy, or to contributors to affiliated packages that have not yet updated astropy-helpers (though I did add a note in the developer docs to try
build_sphinxifbuild_docsdoesn't work).Just front-loading this PR so that it's ready for when we feel it's safe to make the switch.