From e863fd965dd6253243c3342bd6f0adc4fc8aec4d Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 4 May 2024 13:31:33 +0200 Subject: Adding upstream version 5.3.0. Signed-off-by: Daniel Baumann --- doc/_static/Makefile | 6 + doc/_static/bookcover.png | Bin 0 -> 27523 bytes doc/_static/conf.py.txt | 346 ++++++++++++++++++++++ doc/_static/favicon.svg | 8 + doc/_static/more.png | Bin 0 -> 1351 bytes doc/_static/sphinx.png | Bin 0 -> 34213 bytes doc/_static/themes/agogo.png | Bin 0 -> 25792 bytes doc/_static/themes/alabaster.png | Bin 0 -> 32356 bytes doc/_static/themes/bizstyle.png | Bin 0 -> 27139 bytes doc/_static/themes/classic.png | Bin 0 -> 39927 bytes doc/_static/themes/fullsize/agogo.png | Bin 0 -> 56954 bytes doc/_static/themes/fullsize/alabaster.png | Bin 0 -> 40248 bytes doc/_static/themes/fullsize/bizstyle.png | Bin 0 -> 75192 bytes doc/_static/themes/fullsize/classic.png | Bin 0 -> 72597 bytes doc/_static/themes/fullsize/haiku.png | Bin 0 -> 84200 bytes doc/_static/themes/fullsize/nature.png | Bin 0 -> 32266 bytes doc/_static/themes/fullsize/pyramid.png | Bin 0 -> 102717 bytes doc/_static/themes/fullsize/scrolls.png | Bin 0 -> 88111 bytes doc/_static/themes/fullsize/sphinx_rtd_theme.png | Bin 0 -> 39411 bytes doc/_static/themes/fullsize/sphinxdoc.png | Bin 0 -> 84439 bytes doc/_static/themes/fullsize/traditional.png | Bin 0 -> 91744 bytes doc/_static/themes/haiku.png | Bin 0 -> 43184 bytes doc/_static/themes/nature.png | Bin 0 -> 28536 bytes doc/_static/themes/pyramid.png | Bin 0 -> 38805 bytes doc/_static/themes/scrolls.png | Bin 0 -> 27800 bytes doc/_static/themes/sphinx_rtd_theme.png | Bin 0 -> 29138 bytes doc/_static/themes/sphinxdoc.png | Bin 0 -> 30225 bytes doc/_static/themes/traditional.png | Bin 0 -> 32258 bytes doc/_static/translation.png | Bin 0 -> 16371 bytes doc/_static/translation.puml | 16 + doc/_static/translation.svg | 42 +++ doc/_static/tutorial/lumache-autosummary.png | Bin 0 -> 26500 bytes doc/_static/tutorial/lumache-first-light.png | Bin 0 -> 52126 bytes doc/_static/tutorial/lumache-furo.png | Bin 0 -> 51223 bytes doc/_static/tutorial/lumache-py-function-full.png | Bin 0 -> 71741 bytes doc/_static/tutorial/lumache-py-function.png | Bin 0 -> 41828 bytes 36 files changed, 418 insertions(+) create mode 100644 doc/_static/Makefile create mode 100644 doc/_static/bookcover.png create mode 100644 doc/_static/conf.py.txt create mode 100644 doc/_static/favicon.svg create mode 100644 doc/_static/more.png create mode 100644 doc/_static/sphinx.png create mode 100644 doc/_static/themes/agogo.png create mode 100644 doc/_static/themes/alabaster.png create mode 100644 doc/_static/themes/bizstyle.png create mode 100644 doc/_static/themes/classic.png create mode 100644 doc/_static/themes/fullsize/agogo.png create mode 100644 doc/_static/themes/fullsize/alabaster.png create mode 100644 doc/_static/themes/fullsize/bizstyle.png create mode 100644 doc/_static/themes/fullsize/classic.png create mode 100644 doc/_static/themes/fullsize/haiku.png create mode 100644 doc/_static/themes/fullsize/nature.png create mode 100644 doc/_static/themes/fullsize/pyramid.png create mode 100644 doc/_static/themes/fullsize/scrolls.png create mode 100644 doc/_static/themes/fullsize/sphinx_rtd_theme.png create mode 100644 doc/_static/themes/fullsize/sphinxdoc.png create mode 100644 doc/_static/themes/fullsize/traditional.png create mode 100644 doc/_static/themes/haiku.png create mode 100644 doc/_static/themes/nature.png create mode 100644 doc/_static/themes/pyramid.png create mode 100644 doc/_static/themes/scrolls.png create mode 100644 doc/_static/themes/sphinx_rtd_theme.png create mode 100644 doc/_static/themes/sphinxdoc.png create mode 100644 doc/_static/themes/traditional.png create mode 100644 doc/_static/translation.png create mode 100644 doc/_static/translation.puml create mode 100644 doc/_static/translation.svg create mode 100644 doc/_static/tutorial/lumache-autosummary.png create mode 100644 doc/_static/tutorial/lumache-first-light.png create mode 100644 doc/_static/tutorial/lumache-furo.png create mode 100644 doc/_static/tutorial/lumache-py-function-full.png create mode 100644 doc/_static/tutorial/lumache-py-function.png (limited to 'doc/_static') diff --git a/doc/_static/Makefile b/doc/_static/Makefile new file mode 100644 index 0000000..8c880bc --- /dev/null +++ b/doc/_static/Makefile @@ -0,0 +1,6 @@ +translation.png: translation.puml + plantuml -tpng $< +translation.svg: translation.puml + plantuml -tsvg $< +clean: + rm -f translation.png translation.svg diff --git a/doc/_static/bookcover.png b/doc/_static/bookcover.png new file mode 100644 index 0000000..0a8167f Binary files /dev/null and b/doc/_static/bookcover.png differ diff --git a/doc/_static/conf.py.txt b/doc/_static/conf.py.txt new file mode 100644 index 0000000..3077d1b --- /dev/null +++ b/doc/_static/conf.py.txt @@ -0,0 +1,346 @@ +# test documentation build configuration file, created by +# sphinx-quickstart on Sun Jun 26 00:00:43 2016. +# +# This file is executed through importlib.import_module with +# the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +# +# source_encoding = 'utf-8-sig' + +# The master toctree document. +root_doc = 'index' + +# General information about the project. +project = u'test' +copyright = u'2016, test' +author = u'test' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'test' +# The full version, including alpha/beta/rc tags. +release = u'test' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# +# today = '' +# +# Else, today_fmt is used as the format for a strftime call. +# +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# These patterns also affect html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. +# " v documentation" by default. +# +# html_title = u'test vtest' + +# A shorter title for the navigation bar. Default is the same as html_title. +# +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# +# html_logo = None + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# +# html_extra_path = [] + +# If not None, a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +# The empty string is equivalent to '%b %d, %Y'. +# +# html_last_updated_fmt = None + +# Custom sidebar templates, maps document names to template names. +# +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# +# html_additional_pages = {} + +# If false, no module index is generated. +# +# html_domain_indices = True + +# If false, no index is generated. +# +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' +# +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# 'ja' uses this config value. +# 'zh' user can custom change `jieba` dictionary path. +# +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'testdoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (root_doc, 'test.tex', u'test Documentation', + u'test', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# +# latex_logo = None + +# If true, show page references after internal links. +# +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# +# latex_appendices = [] + +# If false, no module index is generated. +# +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (root_doc, 'test', u'test Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +# +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (root_doc, 'test', u'test Documentation', + author, 'test', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# +# texinfo_appendices = [] + +# If false, no module index is generated. +# +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# +# texinfo_no_detailmenu = False + +# If false, do not generate in manual @ref nodes. +# +# texinfo_cross_references = False + +# -- A random example ----------------------------------------------------- + +import sys, os +sys.path.insert(0, os.path.abspath('.')) +exclude_patterns = ['zzz'] + +numfig = True +#language = 'ja' + +extensions.append('sphinx.ext.todo') +extensions.append('sphinx.ext.autodoc') +#extensions.append('sphinx.ext.autosummary') +extensions.append('sphinx.ext.intersphinx') +extensions.append('sphinx.ext.mathjax') +extensions.append('sphinx.ext.viewcode') +extensions.append('sphinx.ext.graphviz') + + +autosummary_generate = True +html_theme = 'default' +#source_suffix = ['.rst', '.txt'] diff --git a/doc/_static/favicon.svg b/doc/_static/favicon.svg new file mode 100644 index 0000000..c3e1acd --- /dev/null +++ b/doc/_static/favicon.svg @@ -0,0 +1,8 @@ + + + + diff --git a/doc/_static/more.png b/doc/_static/more.png new file mode 100644 index 0000000..97553a8 Binary files /dev/null and b/doc/_static/more.png differ diff --git a/doc/_static/sphinx.png b/doc/_static/sphinx.png new file mode 100644 index 0000000..0a103cd Binary files /dev/null and b/doc/_static/sphinx.png differ diff --git a/doc/_static/themes/agogo.png b/doc/_static/themes/agogo.png new file mode 100644 index 0000000..5a09cb9 Binary files /dev/null and b/doc/_static/themes/agogo.png differ diff --git a/doc/_static/themes/alabaster.png b/doc/_static/themes/alabaster.png new file mode 100644 index 0000000..4a49c1a Binary files /dev/null and b/doc/_static/themes/alabaster.png differ diff --git a/doc/_static/themes/bizstyle.png b/doc/_static/themes/bizstyle.png new file mode 100644 index 0000000..e19fb6b Binary files /dev/null and b/doc/_static/themes/bizstyle.png differ diff --git a/doc/_static/themes/classic.png b/doc/_static/themes/classic.png new file mode 100644 index 0000000..3b3c9cb Binary files /dev/null and b/doc/_static/themes/classic.png differ diff --git a/doc/_static/themes/fullsize/agogo.png b/doc/_static/themes/fullsize/agogo.png new file mode 100644 index 0000000..106a16c Binary files /dev/null and b/doc/_static/themes/fullsize/agogo.png differ diff --git a/doc/_static/themes/fullsize/alabaster.png b/doc/_static/themes/fullsize/alabaster.png new file mode 100644 index 0000000..5eca209 Binary files /dev/null and b/doc/_static/themes/fullsize/alabaster.png differ diff --git a/doc/_static/themes/fullsize/bizstyle.png b/doc/_static/themes/fullsize/bizstyle.png new file mode 100644 index 0000000..5860647 Binary files /dev/null and b/doc/_static/themes/fullsize/bizstyle.png differ diff --git a/doc/_static/themes/fullsize/classic.png b/doc/_static/themes/fullsize/classic.png new file mode 100644 index 0000000..269dab2 Binary files /dev/null and b/doc/_static/themes/fullsize/classic.png differ diff --git a/doc/_static/themes/fullsize/haiku.png b/doc/_static/themes/fullsize/haiku.png new file mode 100644 index 0000000..707d2bf Binary files /dev/null and b/doc/_static/themes/fullsize/haiku.png differ diff --git a/doc/_static/themes/fullsize/nature.png b/doc/_static/themes/fullsize/nature.png new file mode 100644 index 0000000..00730c0 Binary files /dev/null and b/doc/_static/themes/fullsize/nature.png differ diff --git a/doc/_static/themes/fullsize/pyramid.png b/doc/_static/themes/fullsize/pyramid.png new file mode 100644 index 0000000..3b9d04d Binary files /dev/null and b/doc/_static/themes/fullsize/pyramid.png differ diff --git a/doc/_static/themes/fullsize/scrolls.png b/doc/_static/themes/fullsize/scrolls.png new file mode 100644 index 0000000..8a1c1fa Binary files /dev/null and b/doc/_static/themes/fullsize/scrolls.png differ diff --git a/doc/_static/themes/fullsize/sphinx_rtd_theme.png b/doc/_static/themes/fullsize/sphinx_rtd_theme.png new file mode 100644 index 0000000..95cff4c Binary files /dev/null and b/doc/_static/themes/fullsize/sphinx_rtd_theme.png differ diff --git a/doc/_static/themes/fullsize/sphinxdoc.png b/doc/_static/themes/fullsize/sphinxdoc.png new file mode 100644 index 0000000..eb498e3 Binary files /dev/null and b/doc/_static/themes/fullsize/sphinxdoc.png differ diff --git a/doc/_static/themes/fullsize/traditional.png b/doc/_static/themes/fullsize/traditional.png new file mode 100644 index 0000000..07ad008 Binary files /dev/null and b/doc/_static/themes/fullsize/traditional.png differ diff --git a/doc/_static/themes/haiku.png b/doc/_static/themes/haiku.png new file mode 100644 index 0000000..4530deb Binary files /dev/null and b/doc/_static/themes/haiku.png differ diff --git a/doc/_static/themes/nature.png b/doc/_static/themes/nature.png new file mode 100644 index 0000000..ad39b32 Binary files /dev/null and b/doc/_static/themes/nature.png differ diff --git a/doc/_static/themes/pyramid.png b/doc/_static/themes/pyramid.png new file mode 100644 index 0000000..72749dd Binary files /dev/null and b/doc/_static/themes/pyramid.png differ diff --git a/doc/_static/themes/scrolls.png b/doc/_static/themes/scrolls.png new file mode 100644 index 0000000..1a11737 Binary files /dev/null and b/doc/_static/themes/scrolls.png differ diff --git a/doc/_static/themes/sphinx_rtd_theme.png b/doc/_static/themes/sphinx_rtd_theme.png new file mode 100644 index 0000000..7c3b7ae Binary files /dev/null and b/doc/_static/themes/sphinx_rtd_theme.png differ diff --git a/doc/_static/themes/sphinxdoc.png b/doc/_static/themes/sphinxdoc.png new file mode 100644 index 0000000..587363e Binary files /dev/null and b/doc/_static/themes/sphinxdoc.png differ diff --git a/doc/_static/themes/traditional.png b/doc/_static/themes/traditional.png new file mode 100644 index 0000000..9820fd0 Binary files /dev/null and b/doc/_static/themes/traditional.png differ diff --git a/doc/_static/translation.png b/doc/_static/translation.png new file mode 100644 index 0000000..002b3d1 Binary files /dev/null and b/doc/_static/translation.png differ diff --git a/doc/_static/translation.puml b/doc/_static/translation.puml new file mode 100644 index 0000000..7b8fc9f --- /dev/null +++ b/doc/_static/translation.puml @@ -0,0 +1,16 @@ +@startuml +file "SphinxProject" +file ".rst" +database ".pot" +database ".po" +database ".mo" +actor translator +file TranslatedBuild +translator -l-> .po +SphinxProject -r-> .rst +.rst -r-> .pot : sphinx-build gettext +.pot -r-> .po : Pootle +.po -d-> .mo : msgfmt +.mo -l-> TranslatedBuild +.rst -d-> TranslatedBuild : "sphinx-build -Dlanguage=" +@enduml diff --git a/doc/_static/translation.svg b/doc/_static/translation.svg new file mode 100644 index 0000000..4e3ab5a --- /dev/null +++ b/doc/_static/translation.svg @@ -0,0 +1,42 @@ +SphinxProject.rst.pot.po.motranslatorTranslatedBuildsphinx-build gettextPootlemsgfmtsphinx-build -Dlanguage= \ No newline at end of file diff --git a/doc/_static/tutorial/lumache-autosummary.png b/doc/_static/tutorial/lumache-autosummary.png new file mode 100644 index 0000000..ed54ea3 Binary files /dev/null and b/doc/_static/tutorial/lumache-autosummary.png differ diff --git a/doc/_static/tutorial/lumache-first-light.png b/doc/_static/tutorial/lumache-first-light.png new file mode 100644 index 0000000..fbf4aec Binary files /dev/null and b/doc/_static/tutorial/lumache-first-light.png differ diff --git a/doc/_static/tutorial/lumache-furo.png b/doc/_static/tutorial/lumache-furo.png new file mode 100644 index 0000000..c7aaee7 Binary files /dev/null and b/doc/_static/tutorial/lumache-furo.png differ diff --git a/doc/_static/tutorial/lumache-py-function-full.png b/doc/_static/tutorial/lumache-py-function-full.png new file mode 100644 index 0000000..d13b637 Binary files /dev/null and b/doc/_static/tutorial/lumache-py-function-full.png differ diff --git a/doc/_static/tutorial/lumache-py-function.png b/doc/_static/tutorial/lumache-py-function.png new file mode 100644 index 0000000..06129d5 Binary files /dev/null and b/doc/_static/tutorial/lumache-py-function.png differ -- cgit v1.2.3