Initial

jameschapman19 · Jan 30, 2023 · 2b57014 · 2b57014
1 parent f43bfd4
commit 2b57014
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 5 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -19,7 +19,9 @@
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-
+extensions = ['autoapi.extension']
+autoapi_dirs = ['../skprox']
+autoapi_add_toctree_entry = False
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

diff --git a/docs/index.rst b/docs/index.rst
@@ -13,6 +13,14 @@ Welcome to scikit-prox's documentation!
    intro
    install
 
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Reference:
+
+   autoapi/skprox/index
+
+
 .. toctree::
    :maxdepth: 2
    :caption: Developer:

diff --git a/docs/install.rst b/docs/install.rst
@@ -1,9 +1,6 @@
 Install
 =======================================
 
-Installing with pip
--------------------
-
-You can install the latest version of the package from PyPI using pip:
+You can install the latest version of the package from PyPI using pip::
 
     $ pip install scikit-prox