Napoleon + config

milcent · Jan 29, 2020 · b5485ba · b5485ba
1 parent 088ca0a
commit b5485ba
Show file tree

Hide file tree

Showing 25 changed files with 761 additions and 957 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,4 @@
+{
+    "restructuredtext.preview.sphinx.disabled": true,
+    "restructuredtext.linter.disabled": true
+}
diff --git a/docs/build/doctrees/benford.doctree b/docs/build/doctrees/benford.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 3e8ac65e43fbc6b1dac5149cc6ed3310
+config: 5f4e07e2ec5552602c9236d1467abd22
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_sources/benford.rst.txt b/docs/build/html/_sources/benford.rst.txt
@@ -0,0 +1,78 @@
+benford package
+===============
+
+Submodules
+----------
+
+benford.benford module
+----------------------
+
+.. automodule:: benford.benford
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+benford.checks module
+---------------------
+
+.. automodule:: benford.checks
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+benford.constants module
+------------------------
+
+.. automodule:: benford.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+benford.expected module
+-----------------------
+
+.. automodule:: benford.expected
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+benford.reports module
+----------------------
+
+.. automodule:: benford.reports
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+benford.stats module
+--------------------
+
+.. automodule:: benford.stats
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+benford.utils module
+--------------------
+
+.. automodule:: benford.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+benford.viz module
+------------------
+
+.. automodule:: benford.viz
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: benford
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
@@ -1,8 +1,3 @@
-.. benford_py documentation master file, created by
-   sphinx-quickstart on Tue Jan 28 23:03:13 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to benford_py's documentation!
 ======================================
 

diff --git a/docs/build/html/_sources/modules.rst.txt b/docs/build/html/_sources/modules.rst.txt
@@ -0,0 +1,7 @@
+benford
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   benford