annotate doc/conf.py @ 463:f520ac3164b0

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