More documentation added

ucapgum · Oct 26, 2020 · a3793d7 · a3793d7
1 parent 64c9fee
commit a3793d7
Show file tree

Hide file tree

Showing 7 changed files with 654 additions and 48 deletions.
diff --git a/.gitignore b/.gitignore
@@ -82,3 +82,6 @@ htmlcov
 
 ### Timing ###
 timing
+
+### Jupyter ###
+.ipynb_checkpoints
diff --git a/docs/conf.py b/docs/conf.py
@@ -34,7 +34,8 @@
     "sphinx.ext.autodoc",
     'sphinx.ext.mathjax',
     'sphinx.ext.napoleon',
-    'sphinx_rtd_theme'
+    'sphinx_rtd_theme',
+    'nbsphinx'
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/index.rst b/docs/index.rst
@@ -10,7 +10,8 @@ Welcome to PyMatching's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-   getting_started
+   installation
+   usage.ipynb
    api
 
 

diff --git a/docs/getting_started.rst → docs/installation.rst b/docs/getting_started.rst → docs/installation.rst
@@ -1,4 +1,4 @@
-Getting Started
+Installation
 ===============
 
 Installing PyMatching
@@ -12,12 +12,3 @@ first clone the repository (you must use the ``--recursive`` flag)::
 and then install using ``pip``::
 
     pip install -e ./PyMatching
-
-
-Usage
------
-
-Much of the functionality of PyMatching is available through the 
-:py:class:`pymatching.matching.Matching` class, which can be imported in Python with::
-
-    from pymatching import Matching