docs: add installation instructions

IATI · May 23, 2024 · f2e5439 · f2e5439
1 parent 3d137c1
commit f2e5439
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 1 deletion.
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,6 +5,15 @@ IATI Sphinx Theme
 .. toctree::
    :titlesonly:
    :maxdepth: 2
-   :caption: Table of Contents
+   :caption: Usage
+   :hidden:
+
+   installation
+
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+   :caption: Development
+   :hidden:
 
    kitchen-sink/index
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -0,0 +1,17 @@
+============
+Installation
+============
+
+1.
+  Install the theme in your Sphinx project.
+
+  .. code-block:: none
+
+    pip install iati-sphinx-theme
+
+2.
+  In your project's :code:`conf.py` set the :code:`html_theme`.
+
+  .. code-block:: python
+
+    html_theme = "iati_sphinx_theme"