Replace old Sphinx build info/options in Readme with summary & doc link #2354
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As noted in #2265 and #2352 , the Readme still has some redundant and somewhat outdated/out of sync information versus what is currently in the build docs (
doc/build) and thebuild.pyscript, including detailed description of setting up, building and viewing the docs with Sphinx that is now covered in updated form indoc/build.rst, and listing thebuild.pyoptions, which are now in the script--help, and are redundant and will drift out of sync here, and which we removed frombuild.rstfor that reason. Therefore, for each, we refer the reader to the respective canonical sources for this information, while leaving a concise high-level summary remaining in the Readme.