|
|
|
@ -19,7 +19,8 @@
|
|
|
|
|
#
|
|
|
|
|
import os
|
|
|
|
|
import sys
|
|
|
|
|
sys.path.insert(0, os.path.abspath('../..'))
|
|
|
|
|
|
|
|
|
|
sys.path.insert(0, os.path.abspath("../.."))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# -- General configuration ------------------------------------------------
|
|
|
|
@ -31,33 +32,33 @@ sys.path.insert(0, os.path.abspath('../..'))
|
|
|
|
|
# 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']
|
|
|
|
|
extensions = ["sphinx.ext.autodoc"]
|
|
|
|
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
|
|
|
templates_path = ['_templates']
|
|
|
|
|
templates_path = ["_templates"]
|
|
|
|
|
|
|
|
|
|
# The suffix(es) of source filenames.
|
|
|
|
|
# You can specify multiple suffix as a list of string:
|
|
|
|
|
#
|
|
|
|
|
# source_suffix = ['.rst', '.md']
|
|
|
|
|
source_suffix = '.rst'
|
|
|
|
|
source_suffix = ".rst"
|
|
|
|
|
|
|
|
|
|
# The master toctree document.
|
|
|
|
|
master_doc = 'index'
|
|
|
|
|
master_doc = "index"
|
|
|
|
|
|
|
|
|
|
# General information about the project.
|
|
|
|
|
project = 'Monero Python module'
|
|
|
|
|
copyright = '2018, Michal Salaban'
|
|
|
|
|
author = 'Michal Salaban'
|
|
|
|
|
project = "Monero Python module"
|
|
|
|
|
copyright = "2018, Michal Salaban"
|
|
|
|
|
author = "Michal Salaban"
|
|
|
|
|
|
|
|
|
|
# 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.9'
|
|
|
|
|
version = "0.9"
|
|
|
|
|
# The full version, including alpha/beta/rc tags.
|
|
|
|
|
release = '0.9'
|
|
|
|
|
release = "0.9"
|
|
|
|
|
|
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
|
|
|
# for a list of supported languages.
|
|
|
|
@ -72,7 +73,7 @@ language = None
|
|
|
|
|
exclude_patterns = []
|
|
|
|
|
|
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
|
|
|
pygments_style = 'sphinx'
|
|
|
|
|
pygments_style = "sphinx"
|
|
|
|
|
|
|
|
|
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
|
|
|
todo_include_todos = False
|
|
|
|
@ -83,7 +84,7 @@ todo_include_todos = False
|
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
|
|
|
# a list of builtin themes.
|
|
|
|
|
#
|
|
|
|
|
html_theme = 'alabaster'
|
|
|
|
|
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
|
|
|
|
@ -94,7 +95,7 @@ html_theme = 'alabaster'
|
|
|
|
|
# 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"]
|
|
|
|
|
|
|
|
|
|
# Custom sidebar templates, must be a dictionary that maps document names
|
|
|
|
|
# to template names.
|
|
|
|
@ -102,21 +103,18 @@ html_static_path = ['_static']
|
|
|
|
|
# This is required for the alabaster theme
|
|
|
|
|
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
|
|
|
|
|
html_sidebars = {
|
|
|
|
|
'index': [
|
|
|
|
|
'relations.html', # needs 'show_related': True theme option to display
|
|
|
|
|
'searchbox.html'
|
|
|
|
|
"index": [
|
|
|
|
|
"relations.html", # needs 'show_related': True theme option to display
|
|
|
|
|
"searchbox.html",
|
|
|
|
|
],
|
|
|
|
|
'**': [
|
|
|
|
|
'searchbox.html',
|
|
|
|
|
'globaltoc.html'
|
|
|
|
|
]
|
|
|
|
|
"**": ["searchbox.html", "globaltoc.html"],
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# -- Options for HTMLHelp output ------------------------------------------
|
|
|
|
|
|
|
|
|
|
# Output file base name for HTML help builder.
|
|
|
|
|
htmlhelp_basename = 'MoneroPythonmoduledoc'
|
|
|
|
|
htmlhelp_basename = "MoneroPythonmoduledoc"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# -- Options for LaTeX output ---------------------------------------------
|
|
|
|
@ -125,15 +123,12 @@ 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',
|
|
|
|
@ -143,8 +138,13 @@ latex_elements = {
|
|
|
|
|
# (source start file, target name, title,
|
|
|
|
|
# author, documentclass [howto, manual, or own class]).
|
|
|
|
|
latex_documents = [
|
|
|
|
|
(master_doc, 'MoneroPythonmodule.tex', 'Monero Python module Documentation',
|
|
|
|
|
'Michal Salaban', 'manual'),
|
|
|
|
|
(
|
|
|
|
|
master_doc,
|
|
|
|
|
"MoneroPythonmodule.tex",
|
|
|
|
|
"Monero Python module Documentation",
|
|
|
|
|
"Michal Salaban",
|
|
|
|
|
"manual",
|
|
|
|
|
),
|
|
|
|
|
]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@ -153,8 +153,13 @@ latex_documents = [
|
|
|
|
|
# One entry per manual page. List of tuples
|
|
|
|
|
# (source start file, name, description, authors, manual section).
|
|
|
|
|
man_pages = [
|
|
|
|
|
(master_doc, 'moneropythonmodule', 'Monero Python module Documentation',
|
|
|
|
|
[author], 1)
|
|
|
|
|
(
|
|
|
|
|
master_doc,
|
|
|
|
|
"moneropythonmodule",
|
|
|
|
|
"Monero Python module Documentation",
|
|
|
|
|
[author],
|
|
|
|
|
1,
|
|
|
|
|
)
|
|
|
|
|
]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@ -164,7 +169,13 @@ man_pages = [
|
|
|
|
|
# (source start file, target name, title, author,
|
|
|
|
|
# dir menu entry, description, category)
|
|
|
|
|
texinfo_documents = [
|
|
|
|
|
(master_doc, 'MoneroPythonmodule', 'Monero Python module Documentation',
|
|
|
|
|
author, 'MoneroPythonmodule', 'One line description of project.',
|
|
|
|
|
'Miscellaneous'),
|
|
|
|
|
(
|
|
|
|
|
master_doc,
|
|
|
|
|
"MoneroPythonmodule",
|
|
|
|
|
"Monero Python module Documentation",
|
|
|
|
|
author,
|
|
|
|
|
"MoneroPythonmodule",
|
|
|
|
|
"One line description of project.",
|
|
|
|
|
"Miscellaneous",
|
|
|
|
|
),
|
|
|
|
|
]
|
|
|
|
|