diff --git a/docs/user_guide/layout.rst b/docs/user_guide/layout.rst index a562f9d8c..7372ad980 100644 --- a/docs/user_guide/layout.rst +++ b/docs/user_guide/layout.rst @@ -12,6 +12,7 @@ Below is a brief overview of the major layout of this theme. Take a look at the diagram to understand what the major sections are called. Where you can insert component templates in ``html_theme_options``, we include the variable name ``in inline code``. Click on section titles to learn more about them and some basic layout configurations. +For complete reference of the existing option please see :ref:`the last section of this page `. .. The directives below generate a grid-like layout that mimics the structure of this theme. .. It uses Sphinx Design grids: https://sphinx-design.readthedocs.io/en/latest/grids.html @@ -589,3 +590,15 @@ If you do specify ``html_last_updated_fmt`` but don't include the :code:`last-up The tag's ``content`` attribute will follow the format specified in the ``html_last_updated_fmt`` configuration variable. + +.. _references: + +References +========== + +Please find here the full list of keys you can use in the ``html_theme_options`` in ``conf.py``: + +.. include:: ../../src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf + :code: ini + :class: highlight-ini +