From f06f2fdf8582a32ff6a87995c27861595394c779 Mon Sep 17 00:00:00 2001 From: jankapunkt Date: Mon, 6 Nov 2023 12:50:40 +0100 Subject: [PATCH] docs: update sphinx conf and index toc --- docs/conf.py | 8 ++++++-- docs/index.rst | 8 ++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index a621e906..bf40262a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -94,7 +94,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -246,7 +246,11 @@ # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'http://docs.python.org/': None} +intersphinx_mapping = { + "rtd": ("https://docs.readthedocs.io/en/stable/", None), + "python": ("https://docs.python.org/3/", None), + "sphinx": ("https://www.sphinx-doc.org/en/master/", None), +} todo_include_todos = True diff --git a/docs/index.rst b/docs/index.rst index 9f83b10a..31956216 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -45,16 +45,15 @@ Example Usage See the :doc:`/model/spec` of what is required from the model passed to :doc:`/api/oauth2-server`. +Contents +-------- .. toctree:: - :hidden: - Home .. toctree:: :maxdepth: 2 :caption: User Documentation - :hidden: docs/getting-started docs/adapters @@ -63,7 +62,6 @@ See the :doc:`/model/spec` of what is required from the model passed to :doc:`/a :maxdepth: 2 :caption: API :includehidden: - :hidden: api/oauth2-server api/request @@ -73,7 +71,6 @@ See the :doc:`/model/spec` of what is required from the model passed to :doc:`/a .. toctree:: :maxdepth: 3 :caption: Model - :hidden: model/overview model/spec @@ -81,7 +78,6 @@ See the :doc:`/model/spec` of what is required from the model passed to :doc:`/a .. toctree:: :maxdepth: 2 :caption: Miscellaneous - :hidden: misc/extension-grants misc/pkce