From ec409133433b9d90fc109ec553704d15a2cf4d3b Mon Sep 17 00:00:00 2001 From: Paul Ganssle Date: Thu, 3 May 2018 16:23:24 -0400 Subject: [PATCH] Reorganize documentation, add inspect Added an "API documentation" section and added the inspect documentation there. --- changelog.d/33.doc.rst | 1 + docs/api/index.rst | 10 ++++++++++ docs/api/inspect.rst | 6 ++++++ docs/api/variants.rst | 6 ++++++ docs/index.rst | 5 +++++ docs/usage.rst | 1 + 6 files changed, 29 insertions(+) create mode 100644 changelog.d/33.doc.rst create mode 100644 docs/api/index.rst create mode 100644 docs/api/inspect.rst create mode 100644 docs/api/variants.rst diff --git a/changelog.d/33.doc.rst b/changelog.d/33.doc.rst new file mode 100644 index 0000000..4ac7b0a --- /dev/null +++ b/changelog.d/33.doc.rst @@ -0,0 +1 @@ +Added section for API documentation, including documentation for the inspect submodule. diff --git a/docs/api/index.rst b/docs/api/index.rst new file mode 100644 index 0000000..d66381b --- /dev/null +++ b/docs/api/index.rst @@ -0,0 +1,10 @@ +========================== +Variants API Documentation +========================== + +.. toctree:: + :maxdepth: 2 + + variants + variants.inspect + diff --git a/docs/api/inspect.rst b/docs/api/inspect.rst new file mode 100644 index 0000000..155da9d --- /dev/null +++ b/docs/api/inspect.rst @@ -0,0 +1,6 @@ +======= +inspect +======= + +.. automodule:: variants.inspect + :members: diff --git a/docs/api/variants.rst b/docs/api/variants.rst new file mode 100644 index 0000000..251af85 --- /dev/null +++ b/docs/api/variants.rst @@ -0,0 +1,6 @@ +======== +variants +======== + +.. automodule:: variants + :members: diff --git a/docs/index.rst b/docs/index.rst index b8eefbe..92fc67d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,6 +21,11 @@ Contents: authors changelog +.. toctree:: + :maxdepth: 2 + + API Documentation + Indices and tables ================== diff --git a/docs/usage.rst b/docs/usage.rst index 55f1e6f..1d1b835 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -7,4 +7,5 @@ decorator, which will add the ``variant`` method to your original function. .. module:: variants .. autofunction:: variants.primary + :noindex: