Skip to content

Commit

Permalink
Docs improvement.
Browse files Browse the repository at this point in the history
  • Loading branch information
juanifioren committed Dec 13, 2024
1 parent d1be6fe commit 836b49b
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 4 deletions.
3 changes: 2 additions & 1 deletion docs/sections/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ All notable changes to this project will be documented in this file.
Unreleased
==========

None
* Changed: Django 5 added to test matrix.
* Changed: ID Token JSON encoder improved using DjangoJSONEncoder.

0.8.3
=====
Expand Down
2 changes: 1 addition & 1 deletion docs/sections/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Improve Documentation

We use `Sphinx <http://www.sphinx-doc.org/>`_ to generate this documentation. If you want to add or modify something just:

* Install Sphinx (``pip install sphinx sphinx_rtd_theme``) and the auto-build tool (``pip install sphinx-autobuild``).
* Install Sphinx and the auto-build tool (``pip install sphinx sphinx_rtd_theme sphinx-autobuild``).
* Move inside the docs folder. ``cd docs/``
* Generate and watch docs by running ``sphinx-autobuild . _build/``.
* Open ``http://127.0.0.1:8000`` in a browser.
23 changes: 21 additions & 2 deletions docs/sections/templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ Templates
Add your own templates files inside a folder named ``templates/oidc_provider/``.
You can copy the sample html files here and customize them with your own style.

**authorize.html**::
authorize.html
==============
::

<h1>Request for Permission</h1>

Expand All @@ -29,7 +31,9 @@ You can copy the sample html files here and customize them with your own style.

</form>

**error.html**::
error.html
==========
::

<h3>{{ error }}</h3>
<p>{{ description }}</p>
Expand All @@ -51,3 +55,18 @@ The following contexts will be passed to the ``authorize`` and ``error`` templat
'error': 'string stating the error',
'description': 'string stating description of the error'
}

end_session_prompt.html
=======================

Read more at :doc:`Session Management > Logout consent prompt </sections/sessionmanagement>` section.

end_session_completed.html
==========================

Read more at :doc:`Session Management > Other scenarios <../sections/sessionmanagement>` section.

end_session_failed.html
=======================

Read more at :doc:`Session Management > Other scenarios <../sections/sessionmanagement>` section.

0 comments on commit 836b49b

Please sign in to comment.