Mercurial > hgrepos > Python > libs > ConfigMix

annotate doc/apidoc.rst @ 126:93964bac7ef6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix the order of documented modules
author Franz Glasner <f.glasner@feldmann-mg.com>
date Wed, 04 Apr 2018 10:57:49 +0200
parents 21d92ff8cf31
children 28e6c1413947
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8 -*-
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
2
102
c8766515bb89 Change the chapter header of the API documentation chapter to "Package API Documentation"
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 82
diff changeset
3 Package API Documentation
c8766515bb89 Change the chapter header of the API documentation chapter to "Package API Documentation"
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 82
diff changeset
4 =========================
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
5
60
6c5e44dc74db Use the "haiku" theme instead of "alabaster" for the mosly API documentation
Franz Glasner <hg@dom66.de>
parents: 56
diff changeset
6 .. contents::
6c5e44dc74db Use the "haiku" theme instead of "alabaster" for the mosly API documentation
Franz Glasner <hg@dom66.de>
parents: 56
diff changeset
7 :local:
6c5e44dc74db Use the "haiku" theme instead of "alabaster" for the mosly API documentation
Franz Glasner <hg@dom66.de>
parents: 56
diff changeset
8
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
9 Package :mod:`configmix`
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
10 ------------------------
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
11
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
12 .. automodule:: configmix
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
13 :members:
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
14 :ignore-module-all:
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
15
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
16
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
17 Module :mod:`configmix.compat`
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
18 ------------------------------
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
19
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
20 .. automodule:: configmix.compat
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
21 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
22 :ignore-module-all:
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
23
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
24
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
25 Module :mod:`configmix.config`
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
26 ------------------------------
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
27
56
1f11672c4615 Optimize the documentation: make references working with Sphinx using :role:`target`
Franz Glasner <hg@dom66.de>
parents: 54
diff changeset
28 .. automodule:: configmix.config
1f11672c4615 Optimize the documentation: make references working with Sphinx using :role:`target`
Franz Glasner <hg@dom66.de>
parents: 54
diff changeset
29 :members:
1f11672c4615 Optimize the documentation: make references working with Sphinx using :role:`target`
Franz Glasner <hg@dom66.de>
parents: 54
diff changeset
30 :ignore-module-all:
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
31
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
32
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
33 Module :mod:`configmix.ini`
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
34 ---------------------------
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
35
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
36 .. automodule:: configmix.ini
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
37 :members:
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
38 :ignore-module-all:
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
39
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
40
126
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
41 Module :mod:`configmix.json`
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
42 ----------------------------
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
43
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
44 .. automodule:: configmix.json
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
45 :members:
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
46 :ignore-module-all:
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
47
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
48
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
49 Module :mod:`configmix.py`
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
50 --------------------------
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
51
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
52 .. automodule:: configmix.py
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
53 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
54 :ignore-module-all:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
55
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
56
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
57 Module :mod:`configmix.variables`
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
58 ---------------------------------
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
59
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
60 .. automodule:: configmix.variables
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
61 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
62 :ignore-module-all:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
63
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
64
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
65 Module :mod:`configmix.yaml`
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
66 ----------------------------
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
67
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
68 .. automodule:: configmix.yaml
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
69 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
70 :ignore-module-all: