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.
Thank you for contributing to Pipenv!
The issue
The docs are long in need of work -- this is revision1 which tackles cleaning up the contents from the
Basics
andAdvanced
sections and splitting them apart. There were some bits left in advanced that I wasn't sure where to put them, so I left that section but renamed it to be other since most of the advanced information moved to other sections. I also added some context on thepipenv update
andpipenv upgrade
commands rework.The fix
This is not the end-all be-all fix to the docs, no this is just progress. I plan to iterate on this more over time -- splitting apart advanced as well.
I was getting frustrated with rst files and found I was having better luck making the new sections markdown.
I am sure I missed some things and its definitely not perfect, but I think its an improvement.
The checklist
news/
directory to describe this fix with the extension.bugfix.rst
,.feature.rst
,.behavior.rst
,.doc.rst
..vendor.rst
. or.trivial.rst
(this will appear in the release changelog). Use semantic line breaks and name the file after the issue number or the PR #.