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.
@dstufft, @pfmoore, since this is a big change, I at least want a +0 or +1 from you two.
here it is in built form: http://www.pip-installer.org/en/docs_refactor/index.html
The main thing here is to have a "User Guide" and "Reference Guide" vs the "Usage", "Cookbook", and "Internal Details" sections. The User/Reference distinction is pretty common, and it does the job I think, along with the "Quickstart" we already have.
pip install
section)This is also consistent with the Standard Pypa Docs Template that I want all PyPA project docs to follow to appear consistent with each other, which will make the PUG more effective I think,
some details:
-W
in the docs build, because we have warnings now due to pages not being in the TOC... option::
for better renderingcc @ncoghlan