From 33d8a97800144d22c2a4ce21407444eb61e5d9ee Mon Sep 17 00:00:00 2001 From: Kegan Maher Date: Sat, 27 Oct 2018 22:31:51 -0700 Subject: [PATCH] starting on autodoc API reference --- Pipfile | 1 + docs/index.rst | 1 + docs/reference/index.rst | 11 +++++++++++ docs/reference/json.rst | 7 +++++++ docs/reference/mds.rst | 6 ++++++ 5 files changed, 26 insertions(+) create mode 100644 docs/reference/index.rst create mode 100644 docs/reference/json.rst create mode 100644 docs/reference/mds.rst diff --git a/Pipfile b/Pipfile index 0734540..0bce0f1 100644 --- a/Pipfile +++ b/Pipfile @@ -10,6 +10,7 @@ sphinx = "*" recommonmark = "*" requests = "*" sphinx-rtd-theme = "*" +mds-provider = {path = "."} [requires] python_version = "3.6" diff --git a/docs/index.rst b/docs/index.rst index a48367d..34bc020 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,6 +8,7 @@ data. :maxdepth: 2 examples/index + reference/index * :ref:`genindex` * :ref:`modindex` diff --git a/docs/reference/index.rst b/docs/reference/index.rst new file mode 100644 index 0000000..1154821 --- /dev/null +++ b/docs/reference/index.rst @@ -0,0 +1,11 @@ +API Reference +============================== + +This is the ``mds-provider`` library API reference. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + mds + json \ No newline at end of file diff --git a/docs/reference/json.rst b/docs/reference/json.rst new file mode 100644 index 0000000..c3f17f5 --- /dev/null +++ b/docs/reference/json.rst @@ -0,0 +1,7 @@ +``mds.json`` Module +============================ + +Json module. + +.. automodule:: mds.json + :members: diff --git a/docs/reference/mds.rst b/docs/reference/mds.rst new file mode 100644 index 0000000..b6066b4 --- /dev/null +++ b/docs/reference/mds.rst @@ -0,0 +1,6 @@ +``mds`` Module +=================================== + +.. automodule:: mds + :members: + :undoc-members: \ No newline at end of file