Mercurial > hgrepos > Python > libs > ConfigMix
annotate docs/index.rst @ 769:4a4d1323b282 default tip
Doc what AWS partition is
| author | Franz Glasner <f.glasner@feldmann-mg.com> |
|---|---|
| date | Mon, 19 Feb 2024 16:11:48 +0100 |
| parents | ab3d0326419c |
| children |
| rev | line source |
|---|---|
|
54
aa8345dae995
Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
53
diff
changeset
|
1 .. -*- coding: utf-8 -*- |
|
aa8345dae995
Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
53
diff
changeset
|
2 |
|
47
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
3 .. ConfigMix documentation master file, created by |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
4 sphinx-quickstart on Tue Feb 27 22:03:52 2018. |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
5 You can adapt this file completely to your liking, but it should at least |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
6 contain the root `toctree` directive. |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
7 |
|
62
617aa948e155
Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents:
58
diff
changeset
|
8 =========== |
|
617aa948e155
Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents:
58
diff
changeset
|
9 ConfigMix |
|
617aa948e155
Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents:
58
diff
changeset
|
10 =========== |
|
58
95034b28f285
Include the LICENSE into the Sphinx documentation
Franz Glasner <hg@dom66.de>
parents:
54
diff
changeset
|
11 |
|
66
e78f307f81a0
For LaTeX: include documents within the toctree only
Franz Glasner <f.glasner@feldmann-mg.com>
parents:
62
diff
changeset
|
12 This is the documentation of the :mod:`configmix` package, a |
|
e78f307f81a0
For LaTeX: include documents within the toctree only
Franz Glasner <f.glasner@feldmann-mg.com>
parents:
62
diff
changeset
|
13 library for helping with configuration files. |
|
54
aa8345dae995
Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
53
diff
changeset
|
14 |
|
47
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
15 .. toctree:: |
|
62
617aa948e155
Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents:
58
diff
changeset
|
16 :maxdepth: 3 |
|
54
aa8345dae995
Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
53
diff
changeset
|
17 |
|
62
617aa948e155
Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents:
58
diff
changeset
|
18 readme |
|
94
2b79ddc0f92b
Begin a basic introduction chapter
Franz Glasner <hg@dom66.de>
parents:
91
diff
changeset
|
19 introduction |
|
86
356ad510542c
Create an AUTHORS.txt file and put into the documentation.
Franz Glasner <hg@dom66.de>
parents:
66
diff
changeset
|
20 apidoc |
| 91 | 21 changes |
|
86
356ad510542c
Create an AUTHORS.txt file and put into the documentation.
Franz Glasner <hg@dom66.de>
parents:
66
diff
changeset
|
22 authors |
|
62
617aa948e155
Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents:
58
diff
changeset
|
23 license |
|
47
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
24 |
|
157
5c377941b0f8
Put the TODO index into the appendices section
Franz Glasner <fzglas.hg@dom66.de>
parents:
94
diff
changeset
|
25 .. toctree:: |
|
5c377941b0f8
Put the TODO index into the appendices section
Franz Glasner <fzglas.hg@dom66.de>
parents:
94
diff
changeset
|
26 :hidden: |
|
5c377941b0f8
Put the TODO index into the appendices section
Franz Glasner <fzglas.hg@dom66.de>
parents:
94
diff
changeset
|
27 |
|
5c377941b0f8
Put the TODO index into the appendices section
Franz Glasner <fzglas.hg@dom66.de>
parents:
94
diff
changeset
|
28 todo |
|
5c377941b0f8
Put the TODO index into the appendices section
Franz Glasner <fzglas.hg@dom66.de>
parents:
94
diff
changeset
|
29 |
|
47
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
30 |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
31 Indices and tables |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
32 ================== |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
33 |
|
62
617aa948e155
Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents:
58
diff
changeset
|
34 .. only:: builder_html |
|
617aa948e155
Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents:
58
diff
changeset
|
35 |
|
157
5c377941b0f8
Put the TODO index into the appendices section
Franz Glasner <fzglas.hg@dom66.de>
parents:
94
diff
changeset
|
36 * :ref:`TODOINDEX` |
|
62
617aa948e155
Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents:
58
diff
changeset
|
37 * :ref:`genindex` |
|
617aa948e155
Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents:
58
diff
changeset
|
38 * :ref:`modindex` |
|
617aa948e155
Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents:
58
diff
changeset
|
39 * :ref:`search` |
|
617aa948e155
Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents:
58
diff
changeset
|
40 |
|
617aa948e155
Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents:
58
diff
changeset
|
41 .. only:: not builder_html |
|
617aa948e155
Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents:
58
diff
changeset
|
42 |
|
157
5c377941b0f8
Put the TODO index into the appendices section
Franz Glasner <fzglas.hg@dom66.de>
parents:
94
diff
changeset
|
43 * :ref:`TODOINDEX` |
|
62
617aa948e155
Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents:
58
diff
changeset
|
44 * :ref:`modindex` |
