# HG changeset patch
# User Franz Glasner <hg@dom66.de>
# Date 1519771331 -3600
# Node ID aa8345dae99581cf9cd37f72ac7d208016377046
# Parent  1d43f0b9fa205a5da872e0771e7c3169e07067d3
Generate readable HTML documentation and an API documentation

diff -r 1d43f0b9fa20 -r aa8345dae995 configmix/__init__.py
--- a/configmix/__init__.py	Tue Feb 27 23:00:32 2018 +0100
+++ b/configmix/__init__.py	Tue Feb 27 23:42:11 2018 +0100
@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
-r"""A library for helping with configuration files.
+r"""
+configmix
+^^^^^^^^^
+
+A library for helping with configuration files.
 
 :Author:   Franz Glasner
 :License:  BSD License.
diff -r 1d43f0b9fa20 -r aa8345dae995 configmix/compat.py
--- a/configmix/compat.py	Tue Feb 27 23:00:32 2018 +0100
+++ b/configmix/compat.py	Tue Feb 27 23:42:11 2018 +0100
@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
-r"""Some minimal compatibility between Python2 and Python3
+r"""
+configmix.compat
+^^^^^^^^^^^^^^^^
+
+Some minimal compatibility between Python2 and Python3
 
 """
 
diff -r 1d43f0b9fa20 -r aa8345dae995 configmix/config.py
--- a/configmix/config.py	Tue Feb 27 23:00:32 2018 +0100
+++ b/configmix/config.py	Tue Feb 27 23:42:11 2018 +0100
@@ -1,6 +1,9 @@
 # -*- coding: utf-8 -*-
-r"""The unified configuration dictionary with attribute support
-or variable substitution.
+r"""configmix.config
+^^^^^^^^^^^^^^^^
+
+The unified configuration dictionary with attribute support or
+variable substitution.
 
 """
 
diff -r 1d43f0b9fa20 -r aa8345dae995 configmix/ini.py
--- a/configmix/ini.py	Tue Feb 27 23:00:32 2018 +0100
+++ b/configmix/ini.py	Tue Feb 27 23:42:11 2018 +0100
@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
-r"""Read INI-style configuration files.
+r"""
+configmix.ini
+^^^^^^^^^^^^^
+
+Read INI-style configuration files.
 
 """
 
diff -r 1d43f0b9fa20 -r aa8345dae995 configmix/py.py
--- a/configmix/py.py	Tue Feb 27 23:00:32 2018 +0100
+++ b/configmix/py.py	Tue Feb 27 23:42:11 2018 +0100
@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
-r"""Read configuration settings from Python files
+r"""
+configmix.py
+^^^^^^^^^^^^
+
+Read configuration settings from Python files
 
 """
 
diff -r 1d43f0b9fa20 -r aa8345dae995 configmix/variables.py
--- a/configmix/variables.py	Tue Feb 27 23:00:32 2018 +0100
+++ b/configmix/variables.py	Tue Feb 27 23:42:11 2018 +0100
@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
-r"""Variable expansion: namespaces and filters
+r"""
+configmix.variables
+^^^^^^^^^^^^^^^^^^^
+
+Variable expansion: namespaces and filters
 
 """
 
diff -r 1d43f0b9fa20 -r aa8345dae995 configmix/yaml.py
--- a/configmix/yaml.py	Tue Feb 27 23:00:32 2018 +0100
+++ b/configmix/yaml.py	Tue Feb 27 23:42:11 2018 +0100
@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
-r"""Simple wrapper for yaml to support all-unicode strings when loading
+r"""
+configmix.yaml
+^^^^^^^^^^^^^^
+
+Simple wrapper for yaml to support all-unicode strings when loading
 configuration files.
 
 """
diff -r 1d43f0b9fa20 -r aa8345dae995 doc/apidoc.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/apidoc.rst	Tue Feb 27 23:42:11 2018 +0100
@@ -0,0 +1,32 @@
+.. -*- coding: utf-8 -*-
+
+Internal Module Documentation
+=============================
+
+.. automodule:: configmix
+   :members:
+   :ignore-module-all:      
+      
+.. automodule:: configmix.compat
+   :members:
+   :ignore-module-all:
+
+.. automodule:: configmix.ini
+   :members:
+   :ignore-module-all:      
+
+.. automodule:: configmix.ini
+   :members:
+   :ignore-module-all:
+
+.. automodule:: configmix.py
+   :members:
+   :ignore-module-all:
+
+.. automodule:: configmix.variables
+   :members:
+   :ignore-module-all:
+
+.. automodule:: configmix.yaml
+   :members:
+   :ignore-module-all:
diff -r 1d43f0b9fa20 -r aa8345dae995 doc/conf.py
--- a/doc/conf.py	Tue Feb 27 23:00:32 2018 +0100
+++ b/doc/conf.py	Tue Feb 27 23:42:11 2018 +0100
@@ -12,9 +12,9 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.dirname(os.path.abspath('.')))
 
 
 # -- Project information -----------------------------------------------------
diff -r 1d43f0b9fa20 -r aa8345dae995 doc/index.rst
--- a/doc/index.rst	Tue Feb 27 23:00:32 2018 +0100
+++ b/doc/index.rst	Tue Feb 27 23:42:11 2018 +0100
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8 -*-
+
 .. ConfigMix documentation master file, created by
    sphinx-quickstart on Tue Feb 27 22:03:52 2018.
    You can adapt this file completely to your liking, but it should at least
@@ -6,9 +8,13 @@
 
 .. include:: ../README
 
+Contents
+========
+
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+
+   apidoc