add docstrings

docs/Makefile

@@ -16,4 +16,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -38,7 +38,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ["sphinx.ext.autodoc"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -84,7 +84,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+html_static_path = []
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

docs/dev/modules.rst

@@ -0,0 +1,7 @@
+snare
+=====
+
+.. toctree::
+   :maxdepth: 4
+
+   snare

docs/dev/snare.rst

@@ -0,0 +1,61 @@
+snare package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   snare.utils
+
+Submodules
+----------
+
+snare.cloner module
+-------------------
+
+.. automodule:: snare.cloner
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+snare.html\_handler module
+--------------------------
+
+.. automodule:: snare.html_handler
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+snare.middlewares module
+------------------------
+
+.. automodule:: snare.middlewares
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+snare.server module
+-------------------
+
+.. automodule:: snare.server
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+snare.tanner\_handler module
+----------------------------
+
+.. automodule:: snare.tanner_handler
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: snare
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/dev/snare.utils.rst

@@ -0,0 +1,45 @@
+snare.utils package
+===================
+
+Submodules
+----------
+
+snare.utils.asyncmock module
+----------------------------
+
+.. automodule:: snare.utils.asyncmock
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+snare.utils.logger module
+-------------------------
+
+.. automodule:: snare.utils.logger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+snare.utils.page\_path\_generator module
+----------------------------------------
+
+.. automodule:: snare.utils.page_path_generator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+snare.utils.snare\_helpers module
+---------------------------------
+
+.. automodule:: snare.utils.snare_helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: snare.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/index.rst

@@ -13,6 +13,7 @@ Welcome to SNARE's documentation!
    quick-start
    parameters
    cloner
+   Snare API <dev/modules>