# HG changeset patch # User Franz Glasner # Date 1521069048 -3600 # Node ID 218807d7d88339073a30b03080f0f4bb7e75c212 # Parent a9ba930a8ecc77e2f1ea9ef20bc8a6a6902dee97 Remove header markup from the Python files and put them into the doc .rst files diff -r a9ba930a8ecc -r 218807d7d883 configmix/__init__.py --- a/configmix/__init__.py Thu Mar 15 00:02:42 2018 +0100 +++ b/configmix/__init__.py Thu Mar 15 00:10:48 2018 +0100 @@ -3,11 +3,7 @@ # :Copyright: (c) 2015-2018, Franz Glasner. All rights reserved. # :License: 3-clause BSD. See LICENSE.txt for details. #- -r""" -configmix -^^^^^^^^^ - -A library for helping with configuration files. +"""A library for helping with configuration files. :Author: Franz Glasner :Copyright: Copyright (c) 2015-2018, Franz Glasner. diff -r a9ba930a8ecc -r 218807d7d883 configmix/compat.py --- a/configmix/compat.py Thu Mar 15 00:02:42 2018 +0100 +++ b/configmix/compat.py Thu Mar 15 00:10:48 2018 +0100 @@ -3,11 +3,7 @@ # :Copyright: (c) 2015-2018, Franz Glasner. All rights reserved. # :License: 3-clause BSD. See LICENSE.txt for details. #- -r""" -configmix.compat -^^^^^^^^^^^^^^^^ - -Some minimal compatibility between Python2 and Python3 +"""Some minimal compatibility shim between Python2 and Python3 """ diff -r a9ba930a8ecc -r 218807d7d883 configmix/config.py --- a/configmix/config.py Thu Mar 15 00:02:42 2018 +0100 +++ b/configmix/config.py Thu Mar 15 00:10:48 2018 +0100 @@ -3,11 +3,7 @@ # :Copyright: (c) 2015-2018, Franz Glasner. All rights reserved. # :License: 3-clause BSD. See LICENSE.txt for details. #- -r""" -configmix.config -^^^^^^^^^^^^^^^^ - -The unified configuration dictionary with attribute support or +"""The unified configuration dictionary with attribute support or variable substitution. """ diff -r a9ba930a8ecc -r 218807d7d883 configmix/ini.py --- a/configmix/ini.py Thu Mar 15 00:02:42 2018 +0100 +++ b/configmix/ini.py Thu Mar 15 00:10:48 2018 +0100 @@ -3,11 +3,7 @@ # :Copyright: (c) 2015-2018, Franz Glasner. All rights reserved. # :License: 3-clause BSD. See LICENSE.txt for details. #- -r""" -configmix.ini -^^^^^^^^^^^^^ - -Read INI-style configuration files. +"""Read INI-style configuration files. """ diff -r a9ba930a8ecc -r 218807d7d883 configmix/py.py --- a/configmix/py.py Thu Mar 15 00:02:42 2018 +0100 +++ b/configmix/py.py Thu Mar 15 00:10:48 2018 +0100 @@ -3,11 +3,7 @@ # :Copyright: (c) 2015-2018, Franz Glasner. All rights reserved. # :License: 3-clause BSD. See LICENSE.txt for details. #- -r""" -configmix.py -^^^^^^^^^^^^ - -Read configuration settings from Python files +"""Read configuration settings from Python files. """ diff -r a9ba930a8ecc -r 218807d7d883 configmix/variables.py --- a/configmix/variables.py Thu Mar 15 00:02:42 2018 +0100 +++ b/configmix/variables.py Thu Mar 15 00:10:48 2018 +0100 @@ -3,11 +3,7 @@ # :Copyright: (c) 2015-2018, Franz Glasner. All rights reserved. # :License: 3-clause BSD. See LICENSE.txt for details. #- -r""" -configmix.variables -^^^^^^^^^^^^^^^^^^^ - -Variable expansion: namespaces and filters +"""Variable expansion: namespaces and filters """ diff -r a9ba930a8ecc -r 218807d7d883 configmix/yaml.py --- a/configmix/yaml.py Thu Mar 15 00:02:42 2018 +0100 +++ b/configmix/yaml.py Thu Mar 15 00:10:48 2018 +0100 @@ -3,11 +3,7 @@ # :Copyright: (c) 2015-2018, Franz Glasner. All rights reserved. # :License: 3-clause BSD. See LICENSE.txt for details. #- -r""" -configmix.yaml -^^^^^^^^^^^^^^ - -Simple wrapper for yaml to support all-unicode strings when loading +"""Simple wrapper for yaml to support all-unicode strings when loading configuration files. """ diff -r a9ba930a8ecc -r 218807d7d883 doc/apidoc.rst --- a/doc/apidoc.rst Thu Mar 15 00:02:42 2018 +0100 +++ b/doc/apidoc.rst Thu Mar 15 00:10:48 2018 +0100 @@ -6,30 +6,57 @@ .. contents:: :local: +Package :mod:`configmix` +------------------------ + .. automodule:: configmix :members: - :ignore-module-all: - + :ignore-module-all: + + +Module :mod:`configmix.compat` +------------------------------ + .. automodule:: configmix.compat :members: :ignore-module-all: - + + +Module :mod:`configmix.config` +------------------------------ + .. automodule:: configmix.config :members: :ignore-module-all: + +Module :mod:`configmix.ini` +--------------------------- + .. automodule:: configmix.ini :members: - :ignore-module-all: + :ignore-module-all: + + +Module :mod:`configmix.py` +-------------------------- .. automodule:: configmix.py :members: :ignore-module-all: + +Module :mod:`configmix.variables` +--------------------------------- + .. automodule:: configmix.variables :members: :ignore-module-all: + +Module :mod:`configmix.yaml` +---------------------------- + .. automodule:: configmix.yaml :members: :ignore-module-all: