Skip to content

Fix documentation build warnings#1648

Open
brianhelba wants to merge 1 commit intodjango-oauth:masterfrom
brianhelba:doc-warning
Open

Fix documentation build warnings#1648
brianhelba wants to merge 1 commit intodjango-oauth:masterfrom
brianhelba:doc-warning

Conversation

@brianhelba
Copy link
Contributor

@brianhelba brianhelba commented Feb 3, 2026

Fixes as many Sphinx warnings as possible.

Checklist

  • PR only contains one change (considered splitting up PR)
  • unit-test added
  • documentation updated
  • CHANGELOG.md updated (only for user relevant changes)
  • author name in AUTHORS
  • tests/app/idp updated to demonstrate new features
  • tests/app/rp updated to demonstrate new features

class_based
application
token
mixins
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

.. automodule:: oauth2_provider.views.mixins
:members:

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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link

codecov bot commented Feb 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Comment on lines +565 to +566
access user's resources, as in
`OpenID Connect Core 1.0 Section 2 <https://openid.net/specs/openid-connect-core-1_0.html#IDToken/>`_.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other parts of this file use a syntax like :rfc:`2.2`, which is parsed by

def rfclink(name, rawtext, text, lineno, inliner, options={}, content=[]):

No such support actually exists for a :openid:`2` syntax.

However, it's apparent that this is the intended external link.

@brianhelba
Copy link
Contributor Author

@dopry Please take a look.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant