# -*- coding: utf-8 -*- # # Configuration file for the Sphinx documentation builder. # # This file does only contain a selection of the most common options. For a # full list see the documentation: # http://www.sphinx-doc.org/en/master/config # -- Path setup -------------------------------------------------------------- # 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. # # pylint: disable=invalid-name,redefined-builtin,wrong-import-position import os import sys import time import datetime build_date = datetime.datetime.fromtimestamp( int(os.environ.get('SOURCE_DATE_EPOCH', time.time())), tz=datetime.timezone.utc, ) sys.path.insert(0, os.path.abspath("..")) import gvm # noqa: E402 # -- Project information ----------------------------------------------------- project = "python-gvm" copyright = f"2018 - {build_date.year}, Greenbone AG" author = "Greenbone AG" # The short X.Y version version = f"{gvm.__version__[0]}.{gvm.__version__[1]}" # The full version, including alpha/beta/rc tags release = gvm.get_version() # -- 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 = [ "myst_parser", "sphinx.ext.autodoc", "sphinx.ext.githubpages", "sphinx.ext.napoleon", ] myst_enable_extensions = ["colon_fence"] myst_heading_anchors = 3 # 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": "restructuredtext"} # The master toctree document. master_doc = "index" # 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 = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ["build", "dist", ".venv"] # -- 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 = "furo" html_title = project html_favicon = "favicon.png" html_css_files = ["custom.css"] html_logo = "_static/logo.svg" html_static_path = ["_static"] repo_url = "https://github.com/greenbone/python-gvm/" html_theme_options = { "source_repository": repo_url, "source_branch": "main", "source_directory": "src/", "light_css_variables": { "color-content-foreground": "#4C4C4C", "color-foreground-primary": "4C4C4C", "color-foreground-secondary": "#7F7F7F", "color-code-background": "#333333", "color-code-foreground": "#E5E5E5", "color-admonition-title--note": "#11AB51", "admonition-font-size": "0.9rem", "color-background-primary": "#FFFFFF", "color-background-secondary": "#F3F3F3", "color-sidebar-background": "#F3F3F3", }, "dark_css_variables": { "color-content-foreground": "#F3F3F3", "color-foreground-primary": "F3F3F3", "color-foreground-secondary": "#E5E5E5", "color-code-background": "#333333", "color-code-foreground": "#E5E5E5", "color-admonition-title--note": "#11AB51", "admonition-font-size": "0.9rem", "color-background-primary": "#171717", "color-background-secondary": "#4C4C4C", "color-sidebar-background": "#333333", }, "footer_icons": [ { "name": "GitHub", "url": repo_url, "html": """ """, "class": "", }, ], } autodoc_typehints = "description" autodoc_typehints_description_target = "documented" autodoc_class_signature = "separated" add_module_names = False pygments_style = "zenburn" # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. htmlhelp_basename = project + "-doc" # -- 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 = [ ( master_doc, project + ".tex", project + " Documentation", "Greenbone AG", "manual", ) ] # -- Options for manual page output ------------------------------------------ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [(master_doc, project, project + " Documentation", [author], 1)] # -- 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 = [ ( master_doc, project, project + " Documentation", author, project, "One line description of project.", "Miscellaneous", ) ] # -- Options for Epub output ------------------------------------------------- # Bibliographic Dublin Core info. epub_title = project # The unique identifier of the text. This can be a ISBN number # or the project homepage. # # epub_identifier = '' # A unique identification for the text. # # epub_uid = '' # A list of files that should not be packed into the epub file. epub_exclude_files = ["search.html"] # -- Extension configuration -------------------------------------------------