Fix documentation build

docs/code.rst

@@ -7,30 +7,24 @@ gvamysql is implemented as `Celery`_ app.
 .. _Celery: http://www.celeryproject.org/
 
 
-The project module :py:mod:`gvamysql`
-=====================================
-
-.. automodule:: gvamysql
-
-
-:py:mod:`gvamysql.celery`
--------------------------
-
-.. automodule:: gvamysql.celery
-   :members:
-
-
-:py:mod:`gvamysql.settings`
----------------------------
-
-.. automodule:: gvamysql.settings
-
-
 :py:mod:`mysqltasks` app
 ========================
 
 .. automodule:: mysqltasks
 
+:py:mod:`mysqltasks.celery`
+---------------------------
+
+.. automodule:: mysqltasks.celery
+   :members:
+
+
+:py:mod:`mysqltasks.settings`
+-----------------------------
+
+.. automodule:: mysqltasks.settings
+
+
 :py:mod:`mysqltasks.tasks`
 --------------------------
 

docs/conf.py

@@ -18,166 +18,167 @@ import os
 # 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(os.path.join('..', 'gvamysql')))
+sys.path.insert(0, os.path.abspath(os.path.join("..", "gvamysql")))
 
-os.environ['GVAMYSQL_BROKER_URL'] = 'amqp://'
+os.environ["GVAMYSQL_BROKER_URL"] = "amqp://"
-os.environ['GVAMYSQL_DBADMIN_HOST'] = 'localhost'
+os.environ["GVAMYSQL_DBADMIN_HOST"] = "localhost"
-os.environ['GVAMYSQL_DBADMIN_PORT'] = "3306"
+os.environ["GVAMYSQL_DBADMIN_PORT"] = "3306"
-os.environ['GVAMYSQL_DBADMIN_USER'] = "gvamysql"
+os.environ["GVAMYSQL_DBADMIN_USER"] = "gvamysql"
-os.environ['GVAMYSQL_DBADMIN_PASSWORD'] = "sUp3rS3cr3t"
+os.environ["GVAMYSQL_DBADMIN_PASSWORD"] = "sUp3rS3cr3t"
 
 
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# 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 = ['releases', 'sphinx.ext.autodoc', 'celery.contrib.sphinx']
+extensions = ["releases", "sphinx.ext.autodoc", "celery.contrib.sphinx"]
+
+# configuration for releases extension
+releases_issue_uri = "https://git.dittberner.info/gnuviech/gvamysql/issues/%s"
+releases_release_uri = "https://git.dittberner.info/gnuviech/gvamysql/src/tag/%s"
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
-
-releases_issue_uri = 'https://git.dittberner.info/gnuviech/gvamysql/issues/%s'
-
-releases_release_uri = 'https://git.dittberner.info/gnuviech/gvamysql/src/tag/%s'
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'gvamysql'
+project = u"gvamysql"
-copyright = u'2014-2020 Jan Dittberner'
+copyright = u"2014-2020 Jan Dittberner"
 
 # 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 = '0.1'
 # The full version, including alpha/beta/rc tags.
-release = '0.1.2'
+from mysqltasks import __version__ as release
+
+# The short X.Y version.
+version = ".".join(release.split(".")[:2])
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ["_build"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# 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
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 
 # -- 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 = 'default'
+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 = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# 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
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# 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']
+html_static_path = ["_static"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'gvamysqldoc'
+htmlhelp_basename = "gvamysqldoc"
 
 
 # -- Options for LaTeX output --------------------------------------------------
@@ -185,10 +186,8 @@ htmlhelp_basename = 'gvamysqldoc'
 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': '',
 }
@@ -196,42 +195,38 @@ latex_elements = {
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-    ('index', 'gvamysql.tex', u'gvamysql Documentation',
+    ("index", "gvamysql.tex", u"gvamysql Documentation", u"Jan Dittberner", "manual")
-     u'Jan Dittberner', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# 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 = [
+man_pages = [("index", "gvamysql", u"gvamysql Documentation", [u"Jan Dittberner"], 1)]
-    ('index', 'gvamysql', u'gvamysql Documentation',
-     [u'Jan Dittberner'], 1)
-]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output ------------------------------------------------
@@ -240,16 +235,22 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'gvamysql', u'gvamysql Documentation',
+    (
-     u'Jan Dittberner', 'gvamysql', 'GNUViech admin MySQL server tools.',
+        "index",
-     'Miscellaneous'),
+        "gvamysql",
+        u"gvamysql Documentation",
+        u"Jan Dittberner",
+        "gvamysql",
+        "GNUViech admin MySQL server tools.",
+        "Miscellaneous",
+    )
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'