Skip to content

Commit

Permalink
docs: add the full option reference in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
12rambau committed Sep 27, 2023
1 parent 8fc9287 commit 3bb1672
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/user_guide/layout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 `the last section of this page <references>`__.

.. 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
Expand Down Expand Up @@ -589,3 +590,16 @@ 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 key you can use in ``conf.py``:

.. include:: ../../src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf
:start-after: [options]
:code: ini
:class: highlight-ini

0 comments on commit 3bb1672

Please sign in to comment.