add API docs

sappelhoff · Apr 1, 2020 · 74f191d · 74f191d
1 parent 88e4487
commit 74f191d
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,19 @@
+:orphan:
+
+.. _api_documentation:
+
+=================
+API Documentation
+=================
+
+Here we list the Application Programming Interface (API) for remedian.
+
+.. currentmodule:: remedian
+
+The :class:`Remedian` class
+----------------------------
+.. autosummary::
+   :toctree: generated/
+
+   Remedian
+   Remedian.add_obs
diff --git a/docs/conf.py b/docs/conf.py
@@ -68,6 +68,7 @@
     "bootstrap_version": "3",
     "navbar_links": [
         ("Examples", "auto_examples/index"),
+        ("API", "api"),
         ("GitHub", "https://github.com/sappelhoff/remedian", True),
     ],
 }