annotate doc/conf.py @ 493:b3cedbee561d

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