|
|
@ -1,4 +1,3 @@ |
|
|
|
# -*- coding: utf-8 -*- |
|
|
|
|
|
|
|
# |
|
|
|
# |
|
|
|
# python_example documentation build configuration file, created by |
|
|
|
# python_example documentation build configuration file, created by |
|
|
|
# sphinx-quickstart on Fri Feb 26 00:29:33 2016. |
|
|
|
# sphinx-quickstart on Fri Feb 26 00:29:33 2016. |
|
|
@ -12,8 +11,8 @@ |
|
|
|
# All configuration values have a default; values that are commented out |
|
|
|
# All configuration values have a default; values that are commented out |
|
|
|
# serve to show the default. |
|
|
|
# serve to show the default. |
|
|
|
|
|
|
|
|
|
|
|
import sys |
|
|
|
|
|
|
|
import os |
|
|
|
import os |
|
|
|
|
|
|
|
import sys |
|
|
|
|
|
|
|
|
|
|
|
# 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 |
|
|
@ -29,41 +28,41 @@ import os |
|
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
|
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
|
|
|
# ones. |
|
|
|
# ones. |
|
|
|
extensions = [ |
|
|
|
extensions = [ |
|
|
|
'sphinx.ext.autodoc', |
|
|
|
"sphinx.ext.autodoc", |
|
|
|
'sphinx.ext.intersphinx', |
|
|
|
"sphinx.ext.intersphinx", |
|
|
|
'sphinx.ext.autosummary', |
|
|
|
"sphinx.ext.autosummary", |
|
|
|
'sphinx.ext.napoleon', |
|
|
|
"sphinx.ext.napoleon", |
|
|
|
] |
|
|
|
] |
|
|
|
|
|
|
|
|
|
|
|
autosummary_generate = True |
|
|
|
autosummary_generate = True |
|
|
|
|
|
|
|
|
|
|
|
# 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"] |
|
|
|
|
|
|
|
|
|
|
|
# The suffix(es) of source filenames. |
|
|
|
# The suffix(es) of source filenames. |
|
|
|
# You can specify multiple suffix as a list of string: |
|
|
|
# You can specify multiple suffix as a list of string: |
|
|
|
# source_suffix = ['.rst', '.md'] |
|
|
|
# source_suffix = ['.rst', '.md'] |
|
|
|
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'python_example' |
|
|
|
project = "python_example" |
|
|
|
copyright = u'2016, Sylvain Corlay' |
|
|
|
copyright = "2016, Sylvain Corlay" |
|
|
|
author = u'Sylvain Corlay' |
|
|
|
author = "Sylvain Corlay" |
|
|
|
|
|
|
|
|
|
|
|
# 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. |
|
|
|
# The short X.Y version. |
|
|
|
version = u'0.0.1' |
|
|
|
version = "0.0.1" |
|
|
|
# The full version, including alpha/beta/rc tags. |
|
|
|
# The full version, including alpha/beta/rc tags. |
|
|
|
release = u'0.0.1' |
|
|
|
release = "0.0.1" |
|
|
|
|
|
|
|
|
|
|
|
# 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. |
|
|
@ -80,7 +79,7 @@ language = None |
|
|
|
|
|
|
|
|
|
|
|
# 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 |
|
|
|
# The reST default role (used for this markup: `text`) to use for all |
|
|
|
# documents. |
|
|
|
# documents. |
|
|
@ -98,7 +97,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 = [] |
|
|
@ -114,7 +113,7 @@ todo_include_todos = False |
|
|
|
|
|
|
|
|
|
|
|
# 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 = 'alabaster' |
|
|
|
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 |
|
|
@ -143,7 +142,7 @@ html_theme = 'alabaster' |
|
|
|
# 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"] |
|
|
|
|
|
|
|
|
|
|
|
# Add any extra paths that contain custom files (such as robots.txt or |
|
|
|
# Add any extra paths that contain custom files (such as robots.txt or |
|
|
|
# .htaccess) here, relative to this directory. These files are copied |
|
|
|
# .htaccess) here, relative to this directory. These files are copied |
|
|
@ -206,20 +205,17 @@ html_static_path = ['_static'] |
|
|
|
# html_search_scorer = 'scorer.js' |
|
|
|
# html_search_scorer = 'scorer.js' |
|
|
|
|
|
|
|
|
|
|
|
# Output file base name for HTML help builder. |
|
|
|
# Output file base name for HTML help builder. |
|
|
|
htmlhelp_basename = 'python_exampledoc' |
|
|
|
htmlhelp_basename = "python_exampledoc" |
|
|
|
|
|
|
|
|
|
|
|
# -- Options for LaTeX output --------------------------------------------- |
|
|
|
# -- Options for LaTeX output --------------------------------------------- |
|
|
|
|
|
|
|
|
|
|
|
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': '', |
|
|
|
|
|
|
|
|
|
|
|
# Latex figure (float) alignment |
|
|
|
# Latex figure (float) alignment |
|
|
|
#'figure_align': 'htbp', |
|
|
|
#'figure_align': 'htbp', |
|
|
|
} |
|
|
|
} |
|
|
@ -228,8 +224,13 @@ latex_elements = { |
|
|
|
# (source start file, target name, title, |
|
|
|
# (source start file, target name, title, |
|
|
|
# author, documentclass [howto, manual, or own class]). |
|
|
|
# author, documentclass [howto, manual, or own class]). |
|
|
|
latex_documents = [ |
|
|
|
latex_documents = [ |
|
|
|
(master_doc, 'python_example.tex', u'python_example Documentation', |
|
|
|
( |
|
|
|
u'Sylvain Corlay', 'manual'), |
|
|
|
master_doc, |
|
|
|
|
|
|
|
"python_example.tex", |
|
|
|
|
|
|
|
"python_example Documentation", |
|
|
|
|
|
|
|
"Sylvain Corlay", |
|
|
|
|
|
|
|
"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 |
|
|
@ -258,8 +259,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 = [ |
|
|
|
(master_doc, 'python_example', u'python_example Documentation', |
|
|
|
(master_doc, "python_example", "python_example Documentation", [author], 1) |
|
|
|
[author], 1) |
|
|
|
|
|
|
|
] |
|
|
|
] |
|
|
|
|
|
|
|
|
|
|
|
# If true, show URL addresses after external links. |
|
|
|
# If true, show URL addresses after external links. |
|
|
@ -272,9 +272,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 = [ |
|
|
|
(master_doc, 'python_example', u'python_example Documentation', |
|
|
|
( |
|
|
|
author, 'python_example', 'One line description of project.', |
|
|
|
master_doc, |
|
|
|
'Miscellaneous'), |
|
|
|
"python_example", |
|
|
|
|
|
|
|
"python_example Documentation", |
|
|
|
|
|
|
|
author, |
|
|
|
|
|
|
|
"python_example", |
|
|
|
|
|
|
|
"One line description of project.", |
|
|
|
|
|
|
|
"Miscellaneous", |
|
|
|
|
|
|
|
), |
|
|
|
] |
|
|
|
] |
|
|
|
|
|
|
|
|
|
|
|
# Documents to append as an appendix to all manuals. |
|
|
|
# Documents to append as an appendix to all manuals. |
|
|
@ -291,4 +297,4 @@ texinfo_documents = [ |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# Example configuration for intersphinx: refer to the Python standard library. |
|
|
|
# Example configuration for intersphinx: refer to the Python standard library. |
|
|
|
intersphinx_mapping = {'https://docs.python.org/': None} |
|
|
|
intersphinx_mapping = {"https://docs.python.org/": None} |
|
|
|