Mercurial > libervia-web
annotate doc/conf.py @ 1525:c921e7002bac
build: don't use local dependencies, and remove backend package:
hatch doesn't support yet editable dependencies
(https://github.com/pypa/hatch/issues/588), and to work on dev, backend and templates must
be installed manually in dev mode. To avoid issues during sync when entering a shell,
those dependencies are disabled and must be installed manually.
author | Goffi <goffi@goffi.org> |
---|---|
date | Thu, 08 Jun 2023 21:07:54 +0200 |
parents | eb00d593801d |
children | c2569408fa35 |
rev | line source |
---|---|
1239 | 1 |
1190
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
2 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
3 # Configuration file for the Sphinx documentation builder. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
4 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
5 # This file does only contain a selection of the most common options. For a |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
6 # full list see the documentation: |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
7 # http://www.sphinx-doc.org/en/master/config |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
8 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
9 # -- Path setup -------------------------------------------------------------- |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
10 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
11 # If extensions (or modules to document with autodoc) are in another directory, |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
12 # add these directories to sys.path here. If the directory is relative to the |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
13 # documentation root, use os.path.abspath to make it absolute, like shown here. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
14 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
15 # import os |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
16 # import sys |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
17 # sys.path.insert(0, os.path.abspath('.')) |
1440
939b5c643f3d
doc: use VERSION file to get version in the same way as for backend
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
18 import os.path |
939b5c643f3d
doc: use VERSION file to get version in the same way as for backend
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
19 import re |
1190
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
20 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
21 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
22 # -- Project information ----------------------------------------------------- |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
23 |
1518
eb00d593801d
refactoring: rename `libervia` to `libervia.web` + update imports following backend changes
Goffi <goffi@goffi.org>
parents:
1502
diff
changeset
|
24 project = u'Libervia Web' |
eb00d593801d
refactoring: rename `libervia` to `libervia.web` + update imports following backend changes
Goffi <goffi@goffi.org>
parents:
1502
diff
changeset
|
25 copyright = u'2019-2023 Jérôme Poisson' |
1190
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
26 author = u'Jérôme Poisson' |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
27 |
1440
939b5c643f3d
doc: use VERSION file to get version in the same way as for backend
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
28 doc_dir = os.path.dirname(os.path.abspath(__file__)) |
1518
eb00d593801d
refactoring: rename `libervia` to `libervia.web` + update imports following backend changes
Goffi <goffi@goffi.org>
parents:
1502
diff
changeset
|
29 version_path = os.path.join(doc_dir, '../libervia/web/VERSION') |
1440
939b5c643f3d
doc: use VERSION file to get version in the same way as for backend
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
30 with open(version_path) as f: |
939b5c643f3d
doc: use VERSION file to get version in the same way as for backend
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
31 version_full = f.read() |
939b5c643f3d
doc: use VERSION file to get version in the same way as for backend
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
32 |
1190
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
33 # The short X.Y version |
1440
939b5c643f3d
doc: use VERSION file to get version in the same way as for backend
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
34 version = re.match(r'[0-9.]+', version_full).group() |
939b5c643f3d
doc: use VERSION file to get version in the same way as for backend
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
35 |
1190
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
36 # The full version, including alpha/beta/rc tags |
1440
939b5c643f3d
doc: use VERSION file to get version in the same way as for backend
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
37 release = version_full |
1190
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
38 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
39 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
40 # -- General configuration --------------------------------------------------- |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
41 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
42 # If your documentation needs a minimal Sphinx version, state it here. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
43 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
44 # needs_sphinx = '1.0' |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
45 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
46 # Add any Sphinx extension module names here, as strings. They can be |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
47 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
48 # ones. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
49 extensions = [ |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
50 'sphinx.ext.autodoc', |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
51 ] |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
52 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
53 # Add any paths that contain templates here, relative to this directory. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
54 templates_path = ['_templates'] |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
55 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
56 # The suffix(es) of source filenames. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
57 # You can specify multiple suffix as a list of string: |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
58 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
59 # source_suffix = ['.rst', '.md'] |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
60 source_suffix = '.rst' |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
61 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
62 # The master toctree document. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
63 master_doc = 'index' |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
64 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
65 # The language for content autogenerated by Sphinx. Refer to documentation |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
66 # for a list of supported languages. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
67 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
68 # This is also used if you do content translation via gettext catalogs. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
69 # Usually you set "language" from the command line for these cases. |
1502
e1ccba0d2b71
doc: set `language` and use `libervia-media` instead of `sat_media`
Goffi <goffi@goffi.org>
parents:
1440
diff
changeset
|
70 language = "en" |
1190
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
71 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
72 # List of patterns, relative to source directory, that match files and |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
73 # directories to ignore when looking for source files. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
74 # This pattern also affects html_static_path and html_extra_path. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
75 exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store'] |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
76 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
77 # The name of the Pygments (syntax highlighting) style to use. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
78 pygments_style = None |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
79 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
80 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
81 # -- Options for HTML output ------------------------------------------------- |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
82 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
83 # The theme to use for HTML and HTML Help pages. See the documentation for |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
84 # a list of builtin themes. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
85 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
86 html_theme = 'alabaster' |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
87 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
88 # Theme options are theme-specific and customize the look and feel of a theme |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
89 # further. For a list of options available for each theme, see the |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
90 # documentation. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
91 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
92 # html_theme_options = {} |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
93 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
94 # Add any paths that contain custom static files (such as style sheets) here, |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
95 # relative to this directory. They are copied after the builtin static files, |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
96 # so a file named "default.css" will overwrite the builtin "default.css". |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
97 html_static_path = ['_static'] |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
98 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
99 # Custom sidebar templates, must be a dictionary that maps document names |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
100 # to template names. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
101 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
102 # The default sidebars (for documents that don't match any pattern) are |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
103 # defined by theme itself. Builtin themes are using these templates by |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
104 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
105 # 'searchbox.html']``. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
106 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
107 # html_sidebars = {} |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
108 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
109 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
110 # -- Options for HTMLHelp output --------------------------------------------- |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
111 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
112 # Output file base name for HTML help builder. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
113 htmlhelp_basename = 'LiberviaSalutToidoc' |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
114 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
115 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
116 # -- Options for LaTeX output ------------------------------------------------ |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
117 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
118 latex_elements = { |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
119 # The paper size ('letterpaper' or 'a4paper'). |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
120 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
121 # 'papersize': 'letterpaper', |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
122 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
123 # The font size ('10pt', '11pt' or '12pt'). |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
124 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
125 # 'pointsize': '10pt', |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
126 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
127 # Additional stuff for the LaTeX preamble. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
128 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
129 # 'preamble': '', |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
130 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
131 # Latex figure (float) alignment |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
132 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
133 # 'figure_align': 'htbp', |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
134 } |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
135 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
136 # Grouping the document tree into LaTeX files. List of tuples |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
137 # (source start file, target name, title, |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
138 # author, documentclass [howto, manual, or own class]). |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
139 latex_documents = [ |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
140 (master_doc, 'LiberviaSalutToi.tex', u'Libervia (Salut à Toi) Documentation', |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
141 u'Jérôme Poisson', 'manual'), |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
142 ] |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
143 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
144 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
145 # -- Options for manual page output ------------------------------------------ |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
146 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
147 # One entry per manual page. List of tuples |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
148 # (source start file, name, description, authors, manual section). |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
149 man_pages = [ |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
150 (master_doc, 'liberviasaluttoi', u'Libervia (Salut à Toi) Documentation', |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
151 [author], 1) |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
152 ] |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
153 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
154 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
155 # -- Options for Texinfo output ---------------------------------------------- |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
156 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
157 # Grouping the document tree into Texinfo files. List of tuples |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
158 # (source start file, target name, title, author, |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
159 # dir menu entry, description, category) |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
160 texinfo_documents = [ |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
161 (master_doc, 'LiberviaSalutToi', u'Libervia (Salut à Toi) Documentation', |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
162 author, 'LiberviaSalutToi', 'One line description of project.', |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
163 'Miscellaneous'), |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
164 ] |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
165 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
166 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
167 # -- Options for Epub output ------------------------------------------------- |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
168 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
169 # Bibliographic Dublin Core info. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
170 epub_title = project |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
171 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
172 # The unique identifier of the text. This can be a ISBN number |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
173 # or the project homepage. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
174 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
175 # epub_identifier = '' |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
176 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
177 # A unique identification for the text. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
178 # |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
179 # epub_uid = '' |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
180 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
181 # A list of files that should not be packed into the epub file. |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
182 epub_exclude_files = ['search.html'] |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
183 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
184 |
b9a5418e9f2e
doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
185 # -- Extension configuration ------------------------------------------------- |