Mercurial > hgrepos > Python > libs > ConfigMix
changeset 54:aa8345dae995
Generate readable HTML documentation and an API documentation
| author | Franz Glasner <hg@dom66.de> |
|---|---|
| date | Tue, 27 Feb 2018 23:42:11 +0100 |
| parents | 1d43f0b9fa20 |
| children | 51a8fa011659 |
| files | configmix/__init__.py configmix/compat.py configmix/config.py configmix/ini.py configmix/py.py configmix/variables.py configmix/yaml.py doc/apidoc.rst doc/conf.py doc/index.rst |
| diffstat | 10 files changed, 77 insertions(+), 12 deletions(-) [+] |
line wrap: on
line diff
--- 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.
--- 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 """
--- 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. """
--- 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. """
--- 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 """
--- 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 """
--- 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. """
--- /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:
--- 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 -----------------------------------------------------
--- 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