diff options
| author | Jonathan Huot <JonathanHuot@users.noreply.github.com> | 2018-02-28 15:00:08 +0100 |
|---|---|---|
| committer | Omer Katz <omer.drow@gmail.com> | 2018-02-28 16:00:08 +0200 |
| commit | 32e5ad1509a8d46fa402776f54fbabef4b1ded63 (patch) | |
| tree | b04ad72e30d5ecc5066712925c791073b05d12a6 /docs | |
| parent | 2fe1cdb88e076f624824496c4aba6a8665e991d9 (diff) | |
| download | oauthlib-32e5ad1509a8d46fa402776f54fbabef4b1ded63.tar.gz | |
Rtd docs fix (#515)
* 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
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/contributing.rst | 10 | ||||
| -rw-r--r-- | docs/faq.rst | 4 | ||||
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rw-r--r-- | docs/installation.rst | 2 | ||||
| -rw-r--r-- | docs/oauth1/preconfigured_servers.rst | 2 | ||||
| -rw-r--r-- | docs/oauth1/server.rst | 2 | ||||
| -rw-r--r-- | docs/oauth2/clients/client.rst | 2 | ||||
| -rw-r--r-- | docs/oauth2/grants/jwt.rst | 2 | ||||
| -rw-r--r-- | docs/oauth2/server.rst | 4 | ||||
| -rw-r--r-- | docs/oauth2/tokens/mac.rst | 2 | ||||
| -rw-r--r-- | docs/oauth2/tokens/saml.rst | 2 | ||||
| -rw-r--r-- | docs/oauth2/tokens/tokens.rst | 4 |
13 files changed, 21 insertions, 19 deletions
diff --git a/docs/conf.py b/docs/conf.py index fb14d05..b1ca34d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -243,3 +243,5 @@ texinfo_documents = [ # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' + +linkcheck_ignore = ["https://github.com/oauthlib/oauthlib/issues/new"] diff --git a/docs/contributing.rst b/docs/contributing.rst index f3de44d..601c567 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -91,7 +91,7 @@ request only to have it rejected because it has diverged too far from master. To pull in upstream changes:: - git remote add upstream https://github.com/idan/oauthlib.git + git remote add upstream https://github.com/oauthlib/oauthlib.git git fetch upstream Check the log to be sure that you actually want the changes, before merging:: @@ -102,7 +102,7 @@ Then merge the changes that you fetched:: git merge upstream/master -For more info, see http://help.github.com/fork-a-repo/ +For more info, see https://help.github.com/fork-a-repo/ How to get your pull request accepted ===================================== @@ -148,7 +148,7 @@ version. For Ubuntu you can easily install all after adding one ppa. $ sudo apt-get install pypy pypy-dev .. _`Tox`: https://tox.readthedocs.io/en/latest/install.html -.. _`virtualenv`: http://www.virtualenv.org/en/latest/#installation +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/installation/ If you add code you need to add tests! -------------------------------------- @@ -223,5 +223,5 @@ to GitHub:: git push upstream master .. _installation: install.html -.. _GitHub project: https://github.com/idan/oauthlib -.. _issue tracker: https://github.com/idan/oauthlib/issues +.. _GitHub project: https://github.com/oauthlib/oauthlib +.. _issue tracker: https://github.com/oauthlib/oauthlib/issues diff --git a/docs/faq.rst b/docs/faq.rst index 0c61af9..38b0e92 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -100,6 +100,6 @@ Some argue OAuth 2 is worse than 1, is that true? .. _`flask-oauthlib`: https://github.com/lepture/flask-oauthlib .. _`pyramid-oauthlib`: https://github.com/tilgovi/pyramid-oauthlib .. _`bottle-oauthlib`: https://github.com/thomsonreuters/bottle-oauthlib -.. _`GitHub issue`: https://github.com/idan/oauthlib/issues/new +.. _`GitHub issue`: https://github.com/oauthlib/oauthlib/issues/new .. _`G+`: https://plus.google.com/communities/101889017375384052571 -.. _`difference`: http://www.cyberciti.biz/faq/authentication-vs-authorization/ +.. _`difference`: https://www.cyberciti.biz/faq/authentication-vs-authorization/ diff --git a/docs/index.rst b/docs/index.rst index 1699068..1da2ca5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,7 +13,7 @@ Check out :doc:`error_reporting` for details on how to be an awesome bug reporte For news and discussions please head over to our `G+ OAuthLib community`_. -.. _`new issue on GitHub`: https://github.com/idan/oauthlib/issues/new +.. _`new issue on GitHub`: https://github.com/oauthlib/oauthlib/issues/new .. _`G+ OAuthLib community`: https://plus.google.com/communities/101889017375384052571 .. toctree:: diff --git a/docs/installation.rst b/docs/installation.rst index 5a8b2cb..48e4288 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -22,7 +22,7 @@ Bleeding edge from GitHub master .. code-block:: bash - pip install -e git+https://github.com/idan/oauthlib.git#egg=oauthlib + pip install -e git+https://github.com/oauthlib/oauthlib.git#egg=oauthlib Debian and derivatives like Ubuntu, Mint, etc. --------------------------------------------- diff --git a/docs/oauth1/preconfigured_servers.rst b/docs/oauth1/preconfigured_servers.rst index 7f7f386..b32e1ab 100644 --- a/docs/oauth1/preconfigured_servers.rst +++ b/docs/oauth1/preconfigured_servers.rst @@ -12,7 +12,7 @@ Construction is simple, only import your validator and you are good to go:: server = WebApplicationServer(your_validator) -All endpoints are documented in :doc:`endpoints`. +All endpoints are documented in :doc:`Provider endpoints <endpoints/endpoints>`. .. autoclass:: oauthlib.oauth1.WebApplicationServer :members: diff --git a/docs/oauth1/server.rst b/docs/oauth1/server.rst index f254c91..2a91f30 100644 --- a/docs/oauth1/server.rst +++ b/docs/oauth1/server.rst @@ -436,7 +436,7 @@ shown below as well as run your flask server locally on port `5000`. Drop a line in our `G+ community`_ or open a `GitHub issue`_ =) .. _`G+ community`: https://plus.google.com/communities/101889017375384052571 -.. _`GitHub issue`: https://github.com/idan/oauthlib/issues/new +.. _`GitHub issue`: https://github.com/oauthlib/oauthlib/issues/new If you run into issues it can be helpful to enable debug logging:: diff --git a/docs/oauth2/clients/client.rst b/docs/oauth2/clients/client.rst index 11da2cc..9a5a4ff 100644 --- a/docs/oauth2/clients/client.rst +++ b/docs/oauth2/clients/client.rst @@ -24,5 +24,5 @@ to use them please browse the documentation for each client type below. If you are interested in integrating OAuth 2 support into your favourite HTTP library you might find the requests-oauthlib implementation interesting. - .. _`requests`: https://github.com/kennethreitz/requests + .. _`requests`: https://github.com/requests/requests .. _`requests-oauthlib`: https://github.com/requests/requests-oauthlib diff --git a/docs/oauth2/grants/jwt.rst b/docs/oauth2/grants/jwt.rst index 87aed11..db65342 100644 --- a/docs/oauth2/grants/jwt.rst +++ b/docs/oauth2/grants/jwt.rst @@ -4,4 +4,4 @@ JWT Tokens Not yet implemented. Track progress in `GitHub issue 50`_. -.. _`GitHub issue 50`: https://github.com/idan/oauthlib/issues/50 +.. _`GitHub issue 50`: https://github.com/oauthlib/oauthlib/issues/50 diff --git a/docs/oauth2/server.rst b/docs/oauth2/server.rst index 9900e36..8f8b77b 100644 --- a/docs/oauth2/server.rst +++ b/docs/oauth2/server.rst @@ -279,7 +279,7 @@ all methods depending on which grant types you wish to support. A skeleton validator listing the methods required for the WebApplicationServer is available in the `examples`_ folder on GitHub. -.. _`examples`: https://github.com/idan/oauthlib/blob/master/examples/skeleton_oauth2_web_application_server.py +.. _`examples`: https://github.com/oauthlib/oauthlib/blob/master/examples/skeleton_oauth2_web_application_server.py Relevant sections include: @@ -496,7 +496,7 @@ at runtime by a function, rather then by a list. Drop a line in our `G+ community`_ or open a `GitHub issue`_ =) .. _`G+ community`: https://plus.google.com/communities/101889017375384052571 -.. _`GitHub issue`: https://github.com/idan/oauthlib/issues/new +.. _`GitHub issue`: https://github.com/oauthlib/oauthlib/issues/new If you run into issues it can be helpful to enable debug logging. diff --git a/docs/oauth2/tokens/mac.rst b/docs/oauth2/tokens/mac.rst index 4986819..afb6948 100644 --- a/docs/oauth2/tokens/mac.rst +++ b/docs/oauth2/tokens/mac.rst @@ -5,4 +5,4 @@ MAC tokens Not yet implemented. Track progress in `GitHub issue 29`_. Might never be supported depending on whether the work on the specification is resumed or not. -.. _`GitHub issue 29`: https://github.com/idan/oauthlib/issues/29 +.. _`GitHub issue 29`: https://github.com/oauthlib/oauthlib/issues/29 diff --git a/docs/oauth2/tokens/saml.rst b/docs/oauth2/tokens/saml.rst index 9a00937..5faf16a 100644 --- a/docs/oauth2/tokens/saml.rst +++ b/docs/oauth2/tokens/saml.rst @@ -4,4 +4,4 @@ SAML Tokens Not yet implemented. Track progress in `GitHub issue 49`_. -.. _`GitHub issue 49`: https://github.com/idan/oauthlib/issues/49 +.. _`GitHub issue 49`: https://github.com/oauthlib/oauthlib/issues/49 diff --git a/docs/oauth2/tokens/tokens.rst b/docs/oauth2/tokens/tokens.rst index f0adc97..f341509 100644 --- a/docs/oauth2/tokens/tokens.rst +++ b/docs/oauth2/tokens/tokens.rst @@ -15,8 +15,8 @@ providers, notably Facebook, do not provide this information. Per the is missing. You can force a ``MissingTokenTypeError`` exception instead, by setting ``OAUTHLIB_STRICT_TOKEN_TYPE`` in the environment. -.. _requires: http://tools.ietf.org/html/rfc6749#section-5.1 -.. _robustness principle: http://en.wikipedia.org/wiki/Robustness_principle +.. _requires: https://tools.ietf.org/html/rfc6749#section-5.1 +.. _robustness principle: https://en.wikipedia.org/wiki/Robustness_principle .. toctree:: :maxdepth: 2 |
