add instructions on how to build docs #295
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## master #295 +/- ##
=======================================
Coverage 67.42% 67.42%
=======================================
Files 12 12
Lines 574 574
Branches 91 91
=======================================
Hits 387 387
Misses 162 162
Partials 25 25Continue to review full report at Codecov.
|
9 tasks
addresses part of issue 11
sigmavirus24
reviewed
Feb 3, 2018
| virtualenvs. | ||
|
|
||
| Building the documentation | ||
| -------------------------- |
There was a problem hiding this comment.
More simply people can use tox to build the documentation. We specify it here: https://github.com/pypa/twine/blob/master/tox.ini#L13 and use it in our test suite. Instructing users to use tox -e docs will make sure everyone sees the exact same output.
|
Excellent! 🍰 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I added some instructions on how to build twine's docs. I used Python 3.6 in my virtual environment but I'm not sure if it's required. Please let me know if there are any changes or additions.