diff --git a/docs/conf.py b/docs/conf.py index c32af9c03..7de3f0504 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -113,7 +113,7 @@ extensions.append("sphinx.ext.intersphinx") intersphinx_mapping = { "python3": ("https://docs.python.org/3.6", None), - "django": ("http://django.readthedocs.org/en/latest/", None), + "django": ("https://django.readthedocs.io/en/latest/", None), } diff --git a/docs/contributing.rst b/docs/contributing.rst index 879c9ace9..39e9ae110 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -253,6 +253,7 @@ tests both ways. You can see the configurations used in tests/settings.py and te When there are multiple databases defined, Django tests will not work unless they are told which database(s) to work with. For test writers this means any test must either: + - instead of Django's TestCase or TransactionTestCase use the versions of those classes defined in tests/common_testing.py - when using pytest's `django_db` mark, define it like this: @@ -386,12 +387,14 @@ working on multiple branches with different dependencies. You can use uv sync to set up your environment and install dependencies and run python:: .. code-block:: bash + uv sync # checks deps, installs virtualenv and dependencies as necessary uv run ... # runs command in the uv environment, syncs deps and python version first if necessary To run tox uv use `tox uv `__:: .. code-block:: bash + uv tool install tox --with tox-uv # use uv to install tox --version # validate you are using the installed tox tox r -e py312 # will use uv diff --git a/docs/management_commands.rst b/docs/management_commands.rst index 3853b3289..b26567583 100644 --- a/docs/management_commands.rst +++ b/docs/management_commands.rst @@ -91,4 +91,3 @@ The ``createapplication`` management command provides a shortcut to create a new --skip-checks Skip system checks. If you let ``createapplication`` auto-generate the secret then it displays the value before hashing it. - diff --git a/docs/settings.rst b/docs/settings.rst index e70d300c9..45eceba8b 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -369,13 +369,13 @@ Whether to always prompt the :term:`Resource Owner` (End User) to confirm a logo :term:`Client` (Relying Party). If it is disabled the :term:`Resource Owner` (End User) will only be prompted if required by the standard. OIDC_RP_INITIATED_LOGOUT_STRICT_REDIRECT_URIS -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Default: ``False`` Enable this setting to require `https` in post logout redirect URIs. `http` is only allowed when a :term:`Client` is `confidential`. OIDC_RP_INITIATED_LOGOUT_ACCEPT_EXPIRED_TOKENS -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Default: ``True`` Whether expired ID tokens are accepted for RP-Initiated Logout. The Tokens must still be signed by the OP and otherwise valid. diff --git a/docs/views/class_based.rst b/docs/views/class_based.rst index d5573a600..802a25c60 100644 --- a/docs/views/class_based.rst +++ b/docs/views/class_based.rst @@ -54,5 +54,5 @@ using the *Class Based View* approach. return HttpResponse('Hello, World!') -Generic views in DOT are obtained composing a set of mixins you can find in the :doc:`views.mixins ` +Generic views in DOT are obtained composing a set of mixins you can find in the :ref:`mixins` module: feel free to use those mixins directly if you want to provide your own class based views. diff --git a/docs/views/details.rst b/docs/views/details.rst index bc145671f..1dad932a9 100644 --- a/docs/views/details.rst +++ b/docs/views/details.rst @@ -10,6 +10,8 @@ Scopes handling. .. automodule:: oauth2_provider.views.generic :members: +.. _mixins: + Mixins ------ These views are mainly for internal use, but advanced users may use them as basic components to customize OAuth2 logic @@ -17,7 +19,6 @@ inside their Django applications. .. automodule:: oauth2_provider.views.mixins :members: - :noindex: Base ---- diff --git a/docs/views/mixins.rst b/docs/views/mixins.rst index a8da12414..0c34990df 100644 --- a/docs/views/mixins.rst +++ b/docs/views/mixins.rst @@ -1,5 +1,5 @@ Mixins for Class Based Views ============================ -.. automodule:: oauth2_provider.views.mixins - :members: +The mixins documentation has moved to the :ref:`mixins` section in +:doc:`details`. diff --git a/oauth2_provider/models.py b/oauth2_provider/models.py index 66c28937b..15082c93a 100644 --- a/oauth2_provider/models.py +++ b/oauth2_provider/models.py @@ -562,7 +562,8 @@ class Meta(AbstractRefreshToken.Meta): class AbstractIDToken(models.Model): """ An IDToken instance represents the actual token to - access user's resources, as defined in the OpenID Connect specification. + access user's resources, as in + `OpenID Connect Core 1.0 Section 2 `_. Fields: