docs: add getting started for python (#51)

jackgerrits · Jul 11, 2023 · 5c928cc · 5c928cc
1 parent e457426
commit 5c928cc
Show file tree

Hide file tree

Showing 5 changed files with 174 additions and 3 deletions.
diff --git a/reductionml-python/docs/environment.yml b/reductionml-python/docs/environment.yml
@@ -5,3 +5,6 @@ dependencies:
   - python=3.10
   - pip:
     - furo
+    - myst-nb
+    - scikit-learn
+    - matplotlib
diff --git a/reductionml-python/docs/source/conf.py b/reductionml-python/docs/source/conf.py
@@ -34,6 +34,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.napoleon",
+    "myst_nb"
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/reductionml-python/docs/source/getting_started.ipynb b/reductionml-python/docs/source/getting_started.ipynb
diff --git a/reductionml-python/docs/source/index.rst b/reductionml-python/docs/source/index.rst
@@ -1,7 +1,14 @@
 reductionml
 ===========
 
-.. automodule:: reductionml
-   :members:
-   :undoc-members:
+Install from PyPi:
 
+.. code-block:: bash
+
+   pip install reductionml
+
+.. toctree::
+   :hidden:
+
+   getting_started
+   reference
diff --git a/reductionml-python/docs/source/reference.rst b/reductionml-python/docs/source/reference.rst
@@ -0,0 +1,6 @@
+Reference
+=========
+
+.. automodule:: reductionml
+   :members:
+   :undoc-members: