Mercurial > hgrepos > Python > libs > ConfigMix

annotate doc/index.rst @ 62:617aa948e155

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Proper layout for HTML and LaTeX output
author Franz Glasner <hg@dom66.de>
date Thu, 01 Mar 2018 00:12:19 +0100
parents 95034b28f285
children e78f307f81a0
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
62
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
12 .. only:: builder_html
58
95034b28f285 Include the LICENSE into the Sphinx documentation
Franz Glasner <hg@dom66.de>
parents: 54
diff changeset
13
62
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
14 This is the documentation of the :mod:`configmix` package, a
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
15 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
16
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
17 .. toctree::
62
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
18 :maxdepth: 3
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents: 53
diff changeset
19
62
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
20 readme
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
21 license
58
95034b28f285 Include the LICENSE into the Sphinx documentation
Franz Glasner <hg@dom66.de>
parents: 54
diff changeset
22 apidoc
47
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
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
25 Indices and tables
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
26 ==================
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
27
62
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
28 .. only:: builder_html
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
29
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
30 * :ref:`genindex`
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
31 * :ref:`modindex`
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
32 * :ref:`search`
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
33
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
34 .. only:: not builder_html
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
35
617aa948e155 Proper layout for HTML and LaTeX output
Franz Glasner <hg@dom66.de>
parents: 58
diff changeset
36 * :ref:`modindex`