Skip to content

Commit 3bb1672

Browse files
committed
docs: add the full option reference in the docs
1 parent 8fc9287 commit 3bb1672

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/user_guide/layout.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Below is a brief overview of the major layout of this theme.
1212
Take a look at the diagram to understand what the major sections are called.
1313
Where you can insert component templates in ``html_theme_options``, we include the variable name ``in inline code``.
1414
Click on section titles to learn more about them and some basic layout configurations.
15+
For complete reference of the existing option please see `the last section of this page <references>`__.
1516

1617
.. The directives below generate a grid-like layout that mimics the structure of this theme.
1718
.. It uses Sphinx Design grids: https://sphinx-design.readthedocs.io/en/latest/grids.html
@@ -589,3 +590,16 @@ If you do specify ``html_last_updated_fmt`` but don't include the :code:`last-up
589590

590591
The tag's ``content`` attribute will follow the format specified in the ``html_last_updated_fmt`` configuration variable.
591592

593+
594+
.. _references:
595+
596+
References
597+
==========
598+
599+
Please find here the full list of key you can use in ``conf.py``:
600+
601+
.. include:: ../../src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf
602+
:start-after: [options]
603+
:code: ini
604+
:class: highlight-ini
605+

0 commit comments

Comments
 (0)