docs: move installation instructions to index page

IATI · May 30, 2024 · 321fb0e · 321fb0e
1 parent e3949c4
commit 321fb0e
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 25 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -2,18 +2,27 @@
 IATI Sphinx Theme
 =================
 
-.. toctree::
-   :titlesonly:
-   :maxdepth: 2
-   :caption: Usage
-   :hidden:
-
-   installation
-
 .. toctree::
    :titlesonly:
    :maxdepth: 1
    :caption: Development
    :hidden:
 
    kitchen-sink/index
+
+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"
diff --git a/docs/installation.rst b/docs/installation.rst