Skip to content

Replace old Sphinx build info/options in Readme with summary & doc link #2354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 22, 2022

Conversation

CAM-Gerlach
Copy link
Member

@CAM-Gerlach CAM-Gerlach commented Feb 22, 2022

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 the build.py script, including detailed description of setting up, building and viewing the docs with Sphinx that is now covered in updated form in doc/build.rst, and listing the build.py options, which are now in the script --help, and are redundant and will drift out of sync here, and which we removed from build.rst for 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants