gnuviech/gvamysql
1
0
Fork 0
Code Issues 1 Pull requests Releases Wiki Activity

Fix documentation build

Browse source
This commit is contained in:
Jan Dittberner 2020-03-04 20:52:29 +01:00
parent 673c3d7051
commit f2550573d2
2 changed files with 87 additions and 92 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docs/code.rst
View file

@ -7,30 +7,24 @@ gvamysql is implemented as `Celery`_ app.
.. _Celery: http://www.celeryproject.org/ .. _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 :py:mod:`mysqltasks` app
======================== ========================
.. automodule:: mysqltasks .. automodule:: mysqltasks
:py:mod:`mysqltasks.celery`
---------------------------
.. automodule:: mysqltasks.celery
:members:
:py:mod:`mysqltasks.settings`
-----------------------------
.. automodule:: mysqltasks.settings
:py:mod:`mysqltasks.tasks` :py:mod:`mysqltasks.tasks`
-------------------------- --------------------------

71
docs/conf.py
View file

@ -18,13 +18,13 @@ import os
# If extensions (or modules to document with autodoc) are in another directory, # 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 # 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. # 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 ----------------------------------------------------- # -- General configuration -----------------------------------------------------
@ -34,36 +34,37 @@ os.environ['GVAMYSQL_DBADMIN_PASSWORD'] = "sUp3rS3cr3t"
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # 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. # 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. # The suffix of source filenames.
source_suffix = '.rst' source_suffix = ".rst"
# The encoding of source files. # The encoding of source files.
# source_encoding = 'utf-8-sig' # source_encoding = 'utf-8-sig'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = "index"
# General information about the project. # 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 # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
# #
# The short X.Y version.
version = '0.1'
# The full version, including alpha/beta/rc tags. # 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 # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -77,7 +78,7 @@ release = '0.1.2'
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # 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. # The reST default role (used for this markup: `text`) to use for all documents.
# default_role = None # default_role = None
@ -94,7 +95,7 @@ exclude_patterns = ['_build']
# show_authors = False # show_authors = False
# The name of the Pygments (syntax highlighting) style to use. # 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. # A list of ignored prefixes for module index sorting.
# modindex_common_prefix = [] # modindex_common_prefix = []
@ -104,7 +105,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # 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 # 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 # further. For a list of options available for each theme, see the
@ -133,7 +134,7 @@ html_theme = 'default'
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # 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, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # using the given strftime format.
@ -177,7 +178,7 @@ html_static_path = ['_static']
# html_file_suffix = None # html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'gvamysqldoc' htmlhelp_basename = "gvamysqldoc"
# -- Options for LaTeX output -------------------------------------------------- # -- Options for LaTeX output --------------------------------------------------
@ -185,10 +186,8 @@ htmlhelp_basename = 'gvamysqldoc'
latex_elements = { latex_elements = {
# The paper size ('letterpaper' or 'a4paper'). # The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper', #'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt'). # The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt', #'pointsize': '10pt',
# Additional stuff for the LaTeX preamble. # Additional stuff for the LaTeX preamble.
#'preamble': '', #'preamble': '',
} }
@ -196,8 +195,7 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ 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 name of an image file (relative to this directory) to place at the top of
@ -225,10 +223,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (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. # If true, show URL addresses after external links.
# man_show_urls = False # man_show_urls = False
@ -240,9 +235,15 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ 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. # Documents to append as an appendix to all manuals.