Add templates for docs

gmrukwa · Oct 26, 2019 · 61524a9 · 61524a9
1 parent 6403f36
commit 61524a9
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/docs/divik.rst b/docs/divik.rst
@@ -0,0 +1,7 @@
+divik package
+=============
+
+.. automodule:: divik
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,21 @@
+.. divik documentation master file, created by
+   sphinx-quickstart on Sat Oct 26 12:33:52 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to divik's documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Contents:
+
+   divik
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`