Mercurial > hgrepos > Python > libs > ConfigMix

annotate doc/index.rst @ 86:356ad510542c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Create an AUTHORS.txt file and put into the documentation. Reorder documentation chapters.
author Franz Glasner <hg@dom66.de>
date Thu, 15 Mar 2018 00:25:09 +0100
parents e78f307f81a0
children 5ca36fbea43d
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: 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
86
356ad510542c Create an AUTHORS.txt file and put into the documentation.
Franz Glasner <hg@dom66.de>
parents: 66
diff changeset
19 apidoc
356ad510542c Create an AUTHORS.txt file and put into the documentation.
Franz Glasner <hg@dom66.de>
parents: 66
diff changeset
20 authors
62
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
21 license
47
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 Indices and tables
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
25 ==================
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
26
62
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
27 .. only:: builder_html
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
28
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
29 * :ref:`genindex`
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
30 * :ref:`modindex`
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
31 * :ref:`search`
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
32
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
33 .. only:: not builder_html
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
34
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
35 * :ref:`modindex`