Skip to content

Commit 2b57014

Browse files
Initial
1 parent f43bfd4 commit 2b57014

File tree

3 files changed

+12
-5
lines changed

3 files changed

+12
-5
lines changed

docs/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@
1919
templates_path = ['_templates']
2020
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
2121

22-
22+
extensions = ['autoapi.extension']
23+
autoapi_dirs = ['../skprox']
24+
autoapi_add_toctree_entry = False
2325

2426
# -- Options for HTML output -------------------------------------------------
2527
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

docs/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ Welcome to scikit-prox's documentation!
1313
intro
1414
install
1515

16+
17+
.. toctree::
18+
:maxdepth: 2
19+
:caption: Reference:
20+
21+
autoapi/skprox/index
22+
23+
1624
.. toctree::
1725
:maxdepth: 2
1826
:caption: Developer:

docs/install.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
Install
22
=======================================
33

4-
Installing with pip
5-
-------------------
6-
7-
You can install the latest version of the package from PyPI using pip:
4+
You can install the latest version of the package from PyPI using pip::
85

96
$ pip install scikit-prox

0 commit comments

Comments
 (0)