Doc updates with some preliminary ddb code

Mohan Kishore · Mohan Kishore · commit 435c50b44a5a · 2018-09-02T23:55:12.000-07:00
diff --git a/Makefile b/Makefile
@@ -66,9 +66,9 @@ coverage: ## check code coverage quickly with the default Python
 	$(BROWSER) htmlcov/index.html
 
 docs: ## generate Sphinx HTML documentation, including API docs
-	rm -f docs/python_dynamodb_lock.rst
-	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ python_dynamodb_lock
+	# rm -f docs/python_dynamodb_lock.rst
+	# rm -f docs/modules.rst
+	sphinx-apidoc -o docs/ -M python_dynamodb_lock
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html
diff --git a/docs/conf.py b/docs/conf.py
@@ -34,6 +34,10 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
 
+# autodoc config
+autoclass_content = 'both'
+add_module_names = False
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -8,7 +8,7 @@ Welcome to Python DynamoDB Lock's documentation!
    readme
    installation
    usage
-   modules
+   python_dynamodb_lock
    contributing
    authors
    history
diff --git a/docs/modules.rst b/docs/modules.rst
@@ -0,0 +1,7 @@
+python_dynamodb_lock
+====================
+
+.. toctree::
+   :maxdepth: 4
+
+   python_dynamodb_lock
diff --git a/docs/python_dynamodb_lock.rst b/docs/python_dynamodb_lock.rst
@@ -0,0 +1,17 @@
+python\_dynamodb\_lock package
+==============================
+
+.. automodule:: python_dynamodb_lock
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+python\_dynamodb\_lock module
+----------------------------------------------------
+
+.. automodule:: python_dynamodb_lock.python_dynamodb_lock
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/python_dynamodb_lock/__init__.py b/python_dynamodb_lock/__init__.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-"""Top-level package for Python DynamoDB Lock."""
+"""The package contains a single module - with the same name i.e. python_dynamodb_lock"""
 
 __author__ = """Mohan Kishore"""
 __email__ = 'mohankishore@yahoo.com'
diff --git a/python_dynamodb_lock/python_dynamodb_lock.py b/python_dynamodb_lock/python_dynamodb_lock.py
