Skip to content

Commit

Permalink
Add extension instruction to README (#27)
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonBoothroyd authored Nov 24, 2021
1 parent 191bc36 commit b7bd345
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,23 @@ or if you have the code checked out locally:
Configuration
-------------

Add the following to your conf.py:
In your `conf.py` add `sphinx_immaterial` as an extension:

.. code-block:: python
extensions = [
...,
"sphinx_immaterial"
]
and add the following:

.. code-block:: python
html_theme = 'sphinx_immaterial'
to set the theme.

Customizing the layout
----------------------

Expand Down

0 comments on commit b7bd345

Please sign in to comment.