Mercurial > libervia-backend
annotate doc/conf.py @ 4094:c3b68fdc2de7
component AP gateway: fix handling of XMPP comments authors:
the gateway was supposing that comments where emitted from PEP of author. While this is
the case for most blog posts, it's not for comments. Instead the component is now using
`author_jid` which is retrieved by XEP-0277 plugin, and reject the item if the auhor is
not verified (i.e. if `publisher` attribute is not set by XMPP service).
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Mon, 12 Jun 2023 14:50:43 +0200 |
| parents | d6837db456fd |
| children | c0bb4b3fdccf |
| 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 | |
|
4077
d6837db456fd
refactoring: fix names in doc following modules hierarchy refactoring
Goffi <goffi@goffi.org>
parents:
3990
diff
changeset
|
26 project = 'Libervia Backend' |
|
d6837db456fd
refactoring: fix names in doc following modules hierarchy refactoring
Goffi <goffi@goffi.org>
parents:
3990
diff
changeset
|
27 copyright = '2019-2023 Libervia' |
| 3479 | 28 author = 'Libervia team' |
| 2946 | 29 |
| 30 doc_dir = os.path.dirname(os.path.abspath(__file__)) | |
|
4077
d6837db456fd
refactoring: fix names in doc following modules hierarchy refactoring
Goffi <goffi@goffi.org>
parents:
3990
diff
changeset
|
31 version_path = os.path.join(doc_dir, '../libervia/backend/VERSION') |
| 2946 | 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 | |
|
3951
4b8776eb6826
doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling:
Goffi <goffi@goffi.org>
parents:
3605
diff
changeset
|
44 |
|
4b8776eb6826
doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling:
Goffi <goffi@goffi.org>
parents:
3605
diff
changeset
|
45 rst_prolog = """ |
|
4b8776eb6826
doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling:
Goffi <goffi@goffi.org>
parents:
3605
diff
changeset
|
46 .. |e2e_arg| replace:: |
|
4b8776eb6826
doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling:
Goffi <goffi@goffi.org>
parents:
3605
diff
changeset
|
47 To publish an end-to-end encrypted item, you can use the ``-e, --encrypt`` flag, and |
|
4b8776eb6826
doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling:
Goffi <goffi@goffi.org>
parents:
3605
diff
changeset
|
48 share secrets with :ref:`libervia-cli_pubsub_secret`. Please read |
|
4b8776eb6826
doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling:
Goffi <goffi@goffi.org>
parents:
3605
diff
changeset
|
49 :ref:`pubsub-encryption` for more details. |
|
3966
9f85369294f3
doc (encryption, cli): pubsub signing documentation:
Goffi <goffi@goffi.org>
parents:
3951
diff
changeset
|
50 |
|
3975
c4418949aa37
doc (encryption, cli): document Pubsub Targeted Encryption:
Goffi <goffi@goffi.org>
parents:
3966
diff
changeset
|
51 .. |pte_arg| replace:: |
|
c4418949aa37
doc (encryption, cli): document Pubsub Targeted Encryption:
Goffi <goffi@goffi.org>
parents:
3966
diff
changeset
|
52 You can encrypt a single item to targeted entities with the ``--encrypt-for`` flag (not |
|
c4418949aa37
doc (encryption, cli): document Pubsub Targeted Encryption:
Goffi <goffi@goffi.org>
parents:
3966
diff
changeset
|
53 to be confused with ``--encrypt`` which is used when a whole node is encrypted). Please |
|
c4418949aa37
doc (encryption, cli): document Pubsub Targeted Encryption:
Goffi <goffi@goffi.org>
parents:
3966
diff
changeset
|
54 read :ref:`pubsub-encryption` for more details. |
|
c4418949aa37
doc (encryption, cli): document Pubsub Targeted Encryption:
Goffi <goffi@goffi.org>
parents:
3966
diff
changeset
|
55 |
|
3966
9f85369294f3
doc (encryption, cli): pubsub signing documentation:
Goffi <goffi@goffi.org>
parents:
3951
diff
changeset
|
56 .. |sign_arg| replace:: |
|
9f85369294f3
doc (encryption, cli): pubsub signing documentation:
Goffi <goffi@goffi.org>
parents:
3951
diff
changeset
|
57 To cryptographically sign an item, you can use the ``-X, --sign`` flag (a mnemonic way |
|
9f85369294f3
doc (encryption, cli): pubsub signing documentation:
Goffi <goffi@goffi.org>
parents:
3951
diff
changeset
|
58 to remember the short option is to think of a cross made as a signature on a document). |
|
9f85369294f3
doc (encryption, cli): pubsub signing documentation:
Goffi <goffi@goffi.org>
parents:
3951
diff
changeset
|
59 Signature can then be checked with :ref:`libervia-cli_pubsub_signature`. Please read |
|
9f85369294f3
doc (encryption, cli): pubsub signing documentation:
Goffi <goffi@goffi.org>
parents:
3951
diff
changeset
|
60 :ref:`pubsub-encryption` for more details. |
|
9f85369294f3
doc (encryption, cli): pubsub signing documentation:
Goffi <goffi@goffi.org>
parents:
3951
diff
changeset
|
61 |
|
3951
4b8776eb6826
doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling:
Goffi <goffi@goffi.org>
parents:
3605
diff
changeset
|
62 """ |
|
4b8776eb6826
doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling:
Goffi <goffi@goffi.org>
parents:
3605
diff
changeset
|
63 |
| 2946 | 64 # If your documentation needs a minimal Sphinx version, state it here. |
| 65 # | |
| 66 # needs_sphinx = '1.0' | |
| 67 | |
| 68 # Add any Sphinx extension module names here, as strings. They can be | |
| 69 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | |
| 70 # ones. | |
| 71 extensions = [ | |
|
3605
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
3505
diff
changeset
|
72 "sphinx.ext.autodoc", |
|
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
3505
diff
changeset
|
73 "docstring" |
| 2946 | 74 ] |
| 75 | |
| 76 # Add any paths that contain templates here, relative to this directory. | |
| 77 templates_path = ['.templates'] | |
| 78 | |
| 79 # The suffix(es) of source filenames. | |
| 80 # You can specify multiple suffix as a list of string: | |
| 81 # | |
| 82 # source_suffix = ['.rst', '.md'] | |
| 83 source_suffix = '.rst' | |
| 84 | |
| 85 # The master toctree document. | |
| 86 master_doc = 'index' | |
| 87 | |
| 88 # The language for content autogenerated by Sphinx. Refer to documentation | |
| 89 # for a list of supported languages. | |
| 90 # | |
| 91 # This is also used if you do content translation via gettext catalogs. | |
| 92 # Usually you set "language" from the command line for these cases. | |
|
3990
3b72743b92db
doc[installation]: update instructions
Goffi <goffi@goffi.org>
parents:
3975
diff
changeset
|
93 language = "en" |
| 2946 | 94 |
| 95 # List of patterns, relative to source directory, that match files and | |
| 96 # directories to ignore when looking for source files. | |
| 97 # This pattern also affects html_static_path and html_extra_path. | |
| 98 exclude_patterns = [u'.build', 'Thumbs.db', '.DS_Store'] | |
| 99 | |
| 100 # The name of the Pygments (syntax highlighting) style to use. | |
| 101 pygments_style = None | |
| 102 | |
| 103 | |
| 104 # -- Options for HTML output ------------------------------------------------- | |
| 105 | |
| 106 # The theme to use for HTML and HTML Help pages. See the documentation for | |
| 107 # a list of builtin themes. | |
| 108 # | |
| 109 html_theme = 'alabaster' | |
| 110 | |
| 111 # Theme options are theme-specific and customize the look and feel of a theme | |
| 112 # further. For a list of options available for each theme, see the | |
| 113 # documentation. | |
| 114 # | |
| 115 # html_theme_options = {} | |
| 116 | |
| 117 # Add any paths that contain custom static files (such as style sheets) here, | |
| 118 # relative to this directory. They are copied after the builtin static files, | |
| 119 # so a file named "default.css" will overwrite the builtin "default.css". | |
| 120 html_static_path = ['.static'] | |
| 121 | |
| 122 # Custom sidebar templates, must be a dictionary that maps document names | |
| 123 # to template names. | |
| 124 # | |
| 125 # The default sidebars (for documents that don't match any pattern) are | |
| 126 # defined by theme itself. Builtin themes are using these templates by | |
| 127 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', | |
| 128 # 'searchbox.html']``. | |
| 129 # | |
| 130 # html_sidebars = {} | |
| 131 | |
| 132 | |
| 133 # -- Options for HTMLHelp output --------------------------------------------- | |
| 134 | |
| 135 # Output file base name for HTML help builder. | |
| 136 htmlhelp_basename = 'SalutToidoc' | |
| 137 | |
| 138 | |
| 139 # -- Options for LaTeX output ------------------------------------------------ | |
| 140 | |
| 141 latex_elements = { | |
| 142 # The paper size ('letterpaper' or 'a4paper'). | |
| 143 # | |
| 144 # 'papersize': 'letterpaper', | |
| 145 | |
| 146 # The font size ('10pt', '11pt' or '12pt'). | |
| 147 # | |
| 148 # 'pointsize': '10pt', | |
| 149 | |
| 150 # Additional stuff for the LaTeX preamble. | |
| 151 # | |
| 152 # 'preamble': '', | |
| 153 | |
| 154 # Latex figure (float) alignment | |
| 155 # | |
| 156 # 'figure_align': 'htbp', | |
| 157 } | |
| 158 | |
| 159 # Grouping the document tree into LaTeX files. List of tuples | |
| 160 # (source start file, target name, title, | |
| 161 # author, documentclass [howto, manual, or own class]). | |
| 162 latex_documents = [ | |
| 3505 | 163 (master_doc, 'SalutToi.tex', u'Libervia Documentation', |
| 164 u'Libervia team', 'manual'), | |
| 2946 | 165 ] |
| 166 | |
| 167 | |
| 168 # -- Options for manual page output ------------------------------------------ | |
| 169 | |
| 170 # One entry per manual page. List of tuples | |
| 171 # (source start file, name, description, authors, manual section). | |
| 172 man_pages = [ | |
| 3505 | 173 (master_doc, 'saluttoi', u'Libervia Documentation', |
| 2946 | 174 [author], 1) |
| 175 ] | |
| 176 | |
| 177 | |
| 178 # -- Options for Texinfo output ---------------------------------------------- | |
| 179 | |
| 180 # Grouping the document tree into Texinfo files. List of tuples | |
| 181 # (source start file, target name, title, author, | |
| 182 # dir menu entry, description, category) | |
| 183 texinfo_documents = [ | |
| 3505 | 184 (master_doc, 'SalutToi', u'Libervia Documentation', |
| 2946 | 185 author, 'SalutToi', 'One line description of project.', |
| 186 'Miscellaneous'), | |
| 187 ] | |
| 188 | |
| 189 | |
| 190 # -- Options for Epub output ------------------------------------------------- | |
| 191 | |
| 192 # Bibliographic Dublin Core info. | |
| 193 epub_title = project | |
| 194 | |
| 195 # The unique identifier of the text. This can be a ISBN number | |
| 196 # or the project homepage. | |
| 197 # | |
| 198 # epub_identifier = '' | |
| 199 | |
| 200 # A unique identification for the text. | |
| 201 # | |
| 202 # epub_uid = '' | |
| 203 | |
| 204 # A list of files that should not be packed into the epub file. | |
| 205 epub_exclude_files = ['search.html'] | |
| 206 | |
| 207 | |
| 208 # -- Extension configuration ------------------------------------------------- |