Mercurial > hgrepos > Python > libs > ConfigMix
annotate doc/index.rst @ 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 | 95034b28f285 |
| 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 |
|
53
1d43f0b9fa20
Make README the content of the master document
Franz Glasner <hg@dom66.de>
parents:
47
diff
changeset
|
8 |
|
1d43f0b9fa20
Make README the content of the master document
Franz Glasner <hg@dom66.de>
parents:
47
diff
changeset
|
9 .. include:: ../README |
|
47
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
10 |
|
54
aa8345dae995
Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
53
diff
changeset
|
11 Contents |
|
aa8345dae995
Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
53
diff
changeset
|
12 ======== |
|
aa8345dae995
Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
53
diff
changeset
|
13 |
|
47
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
14 .. toctree:: |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
15 :maxdepth: 2 |
|
54
aa8345dae995
Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
53
diff
changeset
|
16 |
|
aa8345dae995
Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
53
diff
changeset
|
17 apidoc |
|
47
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
18 |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
19 |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
20 |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
21 Indices and tables |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
22 ================== |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
23 |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
24 * :ref:`genindex` |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
25 * :ref:`modindex` |
|
2ff1e8f02dc7
Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff
changeset
|
26 * :ref:`search` |
