diff options
author | zsdc <taras@vyos.io> | 2022-03-25 20:58:01 +0200 |
---|---|---|
committer | zsdc <taras@vyos.io> | 2022-03-25 21:42:00 +0200 |
commit | 31448cccedd8f841fb3ac7d0f2e3cdefe08a53ba (patch) | |
tree | 349631a02467dae0158f6f663cc8aa8537974a97 /doc/rtd/conf.py | |
parent | 5c4b3943343a85fbe517e5ec1fc670b3a8566b4b (diff) | |
parent | 8537237d80a48c8f0cbf8e66aa4826bbc882b022 (diff) | |
download | vyos-cloud-init-31448cccedd8f841fb3ac7d0f2e3cdefe08a53ba.tar.gz vyos-cloud-init-31448cccedd8f841fb3ac7d0f2e3cdefe08a53ba.zip |
T2117: Cloud-init updated to 22.1
Merged with 22.1 tag from the upstream Cloud-init repository.
Our modules were slightly modified for compatibility with the new
version.
Diffstat (limited to 'doc/rtd/conf.py')
-rw-r--r-- | doc/rtd/conf.py | 45 |
1 files changed, 18 insertions, 27 deletions
diff --git a/doc/rtd/conf.py b/doc/rtd/conf.py index 684822c2..9976afa4 100644 --- a/doc/rtd/conf.py +++ b/doc/rtd/conf.py @@ -1,24 +1,24 @@ import os import sys +from cloudinit import version + # 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. -sys.path.insert(0, os.path.abspath('../../')) -sys.path.insert(0, os.path.abspath('../')) -sys.path.insert(0, os.path.abspath('./')) -sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath("../../")) +sys.path.insert(0, os.path.abspath("../")) +sys.path.insert(0, os.path.abspath("./")) +sys.path.insert(0, os.path.abspath(".")) -from cloudinit import version -from cloudinit.config.schema import get_schema_doc -# Supress warnings for docs that aren't used yet +# Suppress warnings for docs that aren't used yet # unused_docs = [ # ] # General information about the project. -project = 'cloud-init' -copyright = '2020, Canonical Ltd.' +project = "cloud-init" +copyright = "2020, Canonical Ltd." # -- General configuration ---------------------------------------------------- @@ -28,17 +28,17 @@ copyright = '2020, Canonical Ltd.' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ - 'm2r', - 'sphinx.ext.autodoc', - 'sphinx.ext.autosectionlabel', - 'sphinx.ext.viewcode', + "m2r", + "sphinx.ext.autodoc", + "sphinx.ext.autosectionlabel", + "sphinx.ext.viewcode", ] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -47,7 +47,7 @@ version = version.version_string() release = version # Set the default Pygments syntax -highlight_language = 'yaml' +highlight_language = "yaml" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -61,17 +61,8 @@ show_authors = False # 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 = "sphinx_rtd_theme" # The name of an image file (relative to this directory) to place at the top # of the sidebar. -html_logo = 'static/logo.png' - -def generate_docstring_from_schema(app, what, name, obj, options, lines): - """Override module docs from schema when present.""" - if what == 'module' and hasattr(obj, "schema"): - del lines[:] - lines.extend(get_schema_doc(obj.schema).split('\n')) - -def setup(app): - app.connect('autodoc-process-docstring', generate_docstring_from_schema) +html_logo = "static/logo.png" |