diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2021-10-27 03:02:19 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2021-10-27 03:02:19 +0000 |
commit | f2038241cc91dbeee206151c1c17a3c42c5e1968 (patch) | |
tree | 33c29ba68db5ed7e9455a3922ff5f130ba52996e /docs/conf.py | |
parent | Initial commit. (diff) | |
download | pydyf-f2038241cc91dbeee206151c1c17a3c42c5e1968.tar.xz pydyf-f2038241cc91dbeee206151c1c17a3c42c5e1968.zip |
Adding upstream version 0.1.1.upstream/0.1.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..585afd0 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,90 @@ +# pydyf documentation build configuration file. + +import sys +from pathlib import Path + +import pydyf + +# Add current path for css_diagram_role +sys.path.append(str(Path(__file__).parent)) + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [ + 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', + 'sphinx.ext.autosectionlabel'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'pydyf' +copyright = 'CourtBouillon and contributors' + +# 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 full version, including alpha/beta/rc tags. +release = pydyf.__version__ + +# The short X.Y version. +version = '.'.join(release.split('.')[:2]) + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'monokai' + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'sphinx_rtd_theme' + +html_theme_options = { + 'collapse_navigation': False, +} + +# 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 = [] + +# These paths are either relative to html_static_path +# or fully qualified paths (eg. https://...) +html_css_files = [ + 'https://www.courtbouillon.org/static/docs.css', +] + +# Output file base name for HTML help builder. +htmlhelp_basename = 'pydyf2doc' + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'pydyf', 'pydyf Documentation', + ['CourtBouillon and contributors'], 1) +] + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'pydyf', 'pydyf Documentation', + 'CourtBouillon', 'pydyf', + 'A low-level PDF creator', + 'Miscellaneous'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + 'python': ('https://docs.python.org/3/', None), + 'webencodings': ('https://pythonhosted.org/webencodings/', None), +} |