From 2b57014e04e722592ff9a5181a391a20710cdbdc Mon Sep 17 00:00:00 2001 From: jameschapman19 Date: Mon, 30 Jan 2023 12:26:54 +0000 Subject: [PATCH] Initial --- docs/conf.py | 4 +++- docs/index.rst | 8 ++++++++ docs/install.rst | 5 +---- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index d9ec685..04936f2 100644 --- 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 index a414c8b..b683b88 100644 --- 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 index 62146ae..a481d31 100644 --- 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 \ No newline at end of file