Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

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

Merged
AA-Turner merged 1 commit into
python:mainpython/peps:mainfrom
CAM-Gerlach:remove-old-sphinx-info-readmeCAM-Gerlach/peps:remove-old-sphinx-info-readmeCopy head branch name to clipboard
Feb 22, 2022
Merged

Replace old Sphinx build info/options in Readme with summary & doc link#2354
AA-Turner merged 1 commit into
python:mainpython/peps:mainfrom
CAM-Gerlach:remove-old-sphinx-info-readmeCAM-Gerlach/peps:remove-old-sphinx-info-readmeCopy head branch name to clipboard

Conversation

@CAM-Gerlach

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

Copy link
Copy Markdown
Member

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

Morty Proxy This is a proxified and sanitized view of the page, visit original site.