Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add the full option reference in the docs #1485

Merged
merged 9 commits into from Oct 20, 2023
13 changes: 13 additions & 0 deletions docs/user_guide/layout.rst
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>`.
drammock marked this conversation as resolved.
Show resolved Hide resolved

.. 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,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
Comment on lines +594 to +596
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this is unnecessary as section titles are automatically made into crossref targets? But it doesn't hurt anything either and I sorta prefer the explicitness.

==========

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