DOCS - further adding documentation

achim1 · May 26, 2020 · 3f1072e · 3f1072e
1 parent d9598a7
commit 3f1072e
Show file tree

Hide file tree

Showing 5 changed files with 79 additions and 18 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -30,7 +30,16 @@
 # 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',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.githubpages'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -56,3 +65,8 @@
 # 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']
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
+
+
diff --git a/docs/hepbasestack.rst b/docs/hepbasestack.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,6 +10,67 @@ Welcome to hepbasestack's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+hepbasestack
+-------------------------
+
+Tools for resource management, etc.
+
+.. automodule:: hepbasestack
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+hepbasestack.colors module
+--------------------------------
+
+A integration of the seaborn color palette
+
+.. automodule:: hepbasestack.colors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+hepbasestack.itools module
+---------------------------------------
+
+Slicing of lists
+
+.. automodule:: hepbasestack.itools
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+hepbasestack.logger module
+---------------------------------------
+
+A convenient interface for python logging with the possibility
+to set a module wide loglevel at runtime
+
+.. automodule:: hepbasestack.logger
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+hepbasestack.visual module
+--------------------------------------
+
+Predefined style presets for matplotlib
+
+.. automodule:: hepbasestack.visual
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+hepbasestack.layout module
+----------------------------------------
+
+Figure sizes for A4 paper.
+
+.. automodule:: hepbasestack.layout
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
 
 Indices and tables

diff --git a/docs/modules.rst b/docs/modules.rst
diff --git a/setup.cfg b/setup.cfg
@@ -15,3 +15,6 @@ test=pytest
 [tool:pytest]
 addopts = --verbose  
 
+[metadata]
+description-file = README.md
+