From 74f191da66af5bb96ed92ba9c53479a9bf9b68b0 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Wed, 1 Apr 2020 14:17:45 +0200 Subject: [PATCH] add API docs --- docs/api.rst | 19 +++++++++++++++++++ docs/conf.py | 1 + 2 files changed, 20 insertions(+) create mode 100644 docs/api.rst diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..938de8a --- /dev/null +++ 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 index 42eba50..9f55f6e 100644 --- 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), ], }