|
@@ -14,65 +14,62 @@
|
|
|
# serve to show the default.
|
|
|
|
|
|
from __future__ import print_function
|
|
|
-import sys
|
|
|
+
|
|
|
import os
|
|
|
import subprocess
|
|
|
+import sys
|
|
|
|
|
|
from sphinx.util.console import red
|
|
|
|
|
|
# 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('.'))
|
|
|
|
|
|
# -- 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 = [
|
|
|
- 'sphinx.ext.autodoc',
|
|
|
- 'sphinx.ext.coverage',
|
|
|
- 'sphinx.ext.viewcode',
|
|
|
-]
|
|
|
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.coverage", "sphinx.ext.viewcode"]
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
|
-templates_path = ['_templates']
|
|
|
+templates_path = ["_templates"]
|
|
|
|
|
|
# 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 = 'larigira'
|
|
|
-copyright = '2015-2017, boyska'
|
|
|
+project = "larigira"
|
|
|
+copyright = "2015-2017, boyska"
|
|
|
|
|
|
# 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 = '1.3'
|
|
|
+version = "1.3"
|
|
|
# The full version, including alpha/beta/rc tags.
|
|
|
-release = '1.3.1'
|
|
|
+release = "1.3.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.
|
|
@@ -80,167 +77,161 @@ exclude_patterns = []
|
|
|
|
|
|
# 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 = []
|
|
|
|
|
|
# If true, keep warnings as "system message" paragraphs in the built documents.
|
|
|
-#keep_warnings = False
|
|
|
+# keep_warnings = False
|
|
|
|
|
|
|
|
|
# -- 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 = "default"
|
|
|
|
|
|
# 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"]
|
|
|
|
|
|
# Add any extra paths that contain custom files (such as robots.txt or
|
|
|
# .htaccess) here, relative to this directory. These files are copied
|
|
|
# directly to the root of the documentation.
|
|
|
-#html_extra_path = []
|
|
|
+# html_extra_path = []
|
|
|
|
|
|
# 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 = 'larigiradoc'
|
|
|
+htmlhelp_basename = "larigiradoc"
|
|
|
|
|
|
|
|
|
# -- 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': '',
|
|
|
+ # The paper size ('letterpaper' or 'a4paper').
|
|
|
+ #'papersize': 'letterpaper',
|
|
|
+ # The font size ('10pt', '11pt' or '12pt').
|
|
|
+ #'pointsize': '10pt',
|
|
|
+ # Additional stuff for the LaTeX preamble.
|
|
|
+ #'preamble': '',
|
|
|
}
|
|
|
|
|
|
# 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 = [
|
|
|
- ('index', 'larigira.tex', 'larigira Documentation',
|
|
|
- 'boyska', 'manual'),
|
|
|
+ ("index", "larigira.tex", "larigira Documentation", "boyska", "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 = [
|
|
|
- ('index', 'larigira', 'larigira Documentation',
|
|
|
- ['boyska'], 1)
|
|
|
-]
|
|
|
+man_pages = [("index", "larigira", "larigira Documentation", ["boyska"], 1)]
|
|
|
|
|
|
# If true, show URL addresses after external links.
|
|
|
-#man_show_urls = False
|
|
|
+# man_show_urls = False
|
|
|
|
|
|
|
|
|
# -- Options for Texinfo output -------------------------------------------
|
|
@@ -249,52 +240,55 @@ man_pages = [
|
|
|
# (source start file, target name, title, author,
|
|
|
# dir menu entry, description, category)
|
|
|
texinfo_documents = [
|
|
|
- ('index', 'larigira', 'larigira Documentation',
|
|
|
- 'boyska', 'larigira', 'One line description of project.',
|
|
|
- 'Miscellaneous'),
|
|
|
+ (
|
|
|
+ "index",
|
|
|
+ "larigira",
|
|
|
+ "larigira Documentation",
|
|
|
+ "boyska",
|
|
|
+ "larigira",
|
|
|
+ "One line description of project.",
|
|
|
+ "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'
|
|
|
|
|
|
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
|
|
-#texinfo_no_detailmenu = False
|
|
|
+# texinfo_no_detailmenu = False
|
|
|
|
|
|
|
|
|
def run_apidoc(_):
|
|
|
cur_dir = os.path.abspath(os.path.dirname(__file__))
|
|
|
- proj_dir = os.path.abspath(os.path.join(cur_dir, '..', '..'))
|
|
|
- modules = ['larigira']
|
|
|
- exclude_files = [os.path.abspath(os.path.join(proj_dir, excl))
|
|
|
- for excl in ('larigira/rpc.py', 'larigira/dbadmin/')]
|
|
|
- output_path = os.path.join(cur_dir, 'api')
|
|
|
- cmd_path = 'sphinx-apidoc'
|
|
|
- if hasattr(sys, 'real_prefix'): # Are we in a virtualenv?
|
|
|
+ proj_dir = os.path.abspath(os.path.join(cur_dir, "..", ".."))
|
|
|
+ modules = ["larigira"]
|
|
|
+ exclude_files = [
|
|
|
+ os.path.abspath(os.path.join(proj_dir, excl))
|
|
|
+ for excl in ("larigira/rpc.py", "larigira/dbadmin/")
|
|
|
+ ]
|
|
|
+ output_path = os.path.join(cur_dir, "api")
|
|
|
+ cmd_path = "sphinx-apidoc"
|
|
|
+ if hasattr(sys, "real_prefix"): # Are we in a virtualenv?
|
|
|
# assemble the path manually
|
|
|
- cmd_path = os.path.abspath(os.path.join(sys.prefix,
|
|
|
- 'bin',
|
|
|
- 'sphinx-apidoc'))
|
|
|
+ cmd_path = os.path.abspath(os.path.join(sys.prefix, "bin", "sphinx-apidoc"))
|
|
|
if not os.path.exists(cmd_path):
|
|
|
print(red("No apidoc available!"), file=sys.stderr)
|
|
|
return
|
|
|
for module in modules:
|
|
|
try:
|
|
|
- subprocess.check_call([cmd_path,
|
|
|
- '--force',
|
|
|
- '-o', output_path,
|
|
|
- module
|
|
|
- ] + exclude_files,
|
|
|
- cwd=proj_dir
|
|
|
- )
|
|
|
+ subprocess.check_call(
|
|
|
+ [cmd_path, "--force", "-o", output_path, module] + exclude_files,
|
|
|
+ cwd=proj_dir,
|
|
|
+ )
|
|
|
except subprocess.CalledProcessError:
|
|
|
print(red("APIdoc failed for module {}".format(module)))
|
|
|
|
|
|
|
|
|
def setup(app):
|
|
|
- app.connect('builder-inited', run_apidoc)
|
|
|
+ app.connect("builder-inited", run_apidoc)
|