Fix documentation build warnings#1648
Conversation
| class_based | ||
| application | ||
| token | ||
| mixins |
There was a problem hiding this comment.
Sphinx complains:
WARNING: duplicate object description of oauth2_provider.views.mixins, other instance in views/details, use :no-index: for one of them
This is already fully documented here:
django-oauth-toolkit/docs/views/details.rst
Lines 18 to 19 in dbedfaa
Since the other reference has more context and the mixins are indeed more internal than user-facing, keep only those docs.
| The ``createapplication`` management command provides a shortcut to create a new application in a programmatic way. | ||
|
|
||
| .. code-block:: sh | ||
| .. code-block:: console |
There was a problem hiding this comment.
Sphinx complains:
Skip system checks.' as "sh" resulted in an error at token: "'". Retrying in relaxed mode.
console makes more sense: https://pygments.org/docs/lexers/#pygments.lexers.shell.BashSessionLexer
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
| access user's resources, as in | ||
| `OpenID Connect Core 1.0 Section 2 <https://openid.net/specs/openid-connect-core-1_0.html#IDToken/>`_. |
There was a problem hiding this comment.
Other parts of this file use a syntax like :rfc:`2.2`, which is parsed by
django-oauth-toolkit/docs/rfc.py
Line 11 in dbedfaa
No such support actually exists for a :openid:`2` syntax.
However, it's apparent that this is the intended external link.
5ed8dfa to
b98ac8f
Compare
b98ac8f to
890f2cb
Compare
|
@dopry Please take a look. |
Fixes as many Sphinx warnings as possible.
latestbuild.Checklist
CHANGELOG.mdupdated (only for user relevant changes)AUTHORS