WIP: Improve documentation #531
Closed
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
This is due to pyca/cryptography#3970
The wheel package format supports including the license file. This is done using the [metadata] section in the setup.cfg file. For additional information on this feature, see: https://wheel.readthedocs.io/en/stable/index.html#including-the-license-in-the-generated-wheel-file (cherry picked from commit 1421524)
For Travis CI documentation on including a bdist_wheel distribution, see: https://docs.travis-ci.com/user/deployment/pypi/#Uploading-different-distributions Fixes #493 (cherry picked from commit 4b85d90)
* Check access token in self.token dict * fix typo (cherry picked from commit fa0b63c)
(cherry picked from commit 66d7296)
* Added sphinx build for developers Rationale is to build docs locally to prevent RTD to break later. * Replace manual sphinx into make * Renamed idan URL to oauthlib community * Renamed http into https URLs since http is returning 302 * python requests library renamed its home URL * Add ignore list for "make linkcheck" linkcheck is doing requests to github with anonymous access, however creating an issue require an logged-in account * virtualenv changed its homepage and website. * Fixed broken link (cherry picked from commit 32e5ad1)
(cherry picked from commit 3d24818)
(cherry picked from commit d93403a)
(cherry picked from commit 70b5827)
(cherry picked from commit f398fdb)
(cherry picked from commit ad61175)
(cherry picked from commit 9855c6b)
(cherry picked from commit 3e13cd3)
(cherry picked from commit 6490295)
(cherry picked from commit ec0e618)
* Fix indentation in Travis config. * Fill GitHub OAuth key. * Deploy tags from all branches. (cherry picked from commit e2f40a9)
* Added sphinx build for developers Rationale is to build docs locally to prevent RTD to break later. * Replace manual sphinx into make * Renamed idan URL to oauthlib community * Renamed http into https URLs since http is returning 302 * python requests library renamed its home URL * Add ignore list for "make linkcheck" linkcheck is doing requests to github with anonymous access, however creating an issue require an logged-in account * virtualenv changed its homepage and website. * Fixed broken link (cherry picked from commit 32e5ad1)
|
This branch diverged too much, recreating one. |
Merged
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.
Wanted to improve documentation to both be sure we have no errors, nor misleading examples, and also be clear for new users.
Started with another round of review lead me to fix minors stuff (copyright, typo, ..), but also I have added a credits to previous team.
Also, setup.py/long_description aka README.rst is now tested locally before pushed to pypi (and github).
The already identified areas of improvements are: #209 #213 #234 #242 #287 #320 #373 thanks to @ib-lundgren for this list.