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