|
|
#!/usr/bin/env python3
|
|
|
|
|
|
|
|
|
# actes_princiers documentation build
|
|
|
# configuration file, created by sphinx-quickstart.
|
|
|
#
|
|
|
# This file is execfile()d with the current directory set to its
|
|
|
# containing dir.
|
|
|
#
|
|
|
# Note that not all possible configuration values are present in this
|
|
|
# autogenerated file.
|
|
|
#
|
|
|
# All configuration values have a default; values that are commented out
|
|
|
# serve to show the default.
|
|
|
|
|
|
# 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.
|
|
|
#
|
|
|
import re
|
|
|
|
|
|
from kedro.framework.cli.utils import find_stylesheets
|
|
|
|
|
|
#from actes_princiers import __version__ as release
|
|
|
release = "0.1"
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
|
|
project = "actes_princiers"
|
|
|
author = "Jean-Damien"
|
|
|
|
|
|
# The short X.Y version.
|
|
|
version = re.match(r"^([0-9]+\.[0-9]+).*", release).group(1)
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
|
|
# If your documentation needs a minimal Sphinx version, state it here.
|
|
|
#
|
|
|
# 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.napoleon",
|
|
|
"sphinx.ext.todo",
|
|
|
"sphinx.ext.coverage",
|
|
|
"sphinx.ext.ifconfig",
|
|
|
"sphinx.ext.viewcode",
|
|
|
"myst_parser",
|
|
|
#"nbsphinx",
|
|
|
#"sphinx_copybutton",
|
|
|
]
|
|
|
|
|
|
# enable autosummary plugin (table of contents for modules/classes/class
|
|
|
# methods)
|
|
|
autosummary_generate = True
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
|
templates_path = ["_templates"]
|
|
|
|
|
|
# The suffix(es) of source filenames.
|
|
|
# You can specify multiple suffix as a list of string:
|
|
|
#
|
|
|
source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
|
|
|
|
|
|
# The master toctree document.
|
|
|
master_doc = "index"
|
|
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
|
# for a list of supported languages.
|
|
|
#
|
|
|
# This is also used if you do content translation via gettext catalogs.
|
|
|
# Usually you set "language" from the command line for these cases.
|
|
|
language = 'fr'
|
|
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
|
# directories to ignore when looking for source files.
|
|
|
# This pattern also affects html_static_path and html_extra_path .
|
|
|
exclude_patterns = ["_build", "**.ipynb_checkpoints"]
|
|
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
|
pygments_style = "sphinx"
|
|
|
|
|
|
# -- 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 = "sphinx_rtd_theme"
|
|
|
html_theme = "bizstyle"
|
|
|
|
|
|
# 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 = {"collapse_navigation": False, "style_external_links": True}
|
|
|
|
|
|
# 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"]
|
|
|
|
|
|
# Custom sidebar templates, must be a dictionary that maps document names
|
|
|
# to template names.
|
|
|
#
|
|
|
# The default sidebars (for documents that don't match any pattern) are
|
|
|
# defined by theme itself. Builtin themes are using these templates by
|
|
|
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
|
|
|
# 'searchbox.html']``.
|
|
|
#
|
|
|
# html_sidebars = {}
|
|
|
|
|
|
html_show_sourcelink = False
|
|
|
|
|
|
# -- Options for HTMLHelp output ---------------------------------------------
|
|
|
|
|
|
# Output file base name for HTML help builder.
|
|
|
htmlhelp_basename = "actes_princiersdoc"
|
|
|
|
|
|
# -- 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': '',
|
|
|
#
|
|
|
# Latex figure (float) alignment
|
|
|
#
|
|
|
# 'figure_align': 'htbp',
|
|
|
}
|
|
|
|
|
|
# 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 = [
|
|
|
(
|
|
|
master_doc,
|
|
|
"actes_princiers.tex",
|
|
|
"actes_princiers Documentation",
|
|
|
"Kedro",
|
|
|
"manual",
|
|
|
)
|
|
|
]
|
|
|
|
|
|
# -- Options for manual page output ------------------------------------------
|
|
|
|
|
|
# One entry per manual page. List of tuples
|
|
|
# (source start file, name, description, authors, manual section).
|
|
|
man_pages = [
|
|
|
(
|
|
|
master_doc,
|
|
|
"actes_princiers",
|
|
|
"actes_princiers Documentation",
|
|
|
[author],
|
|
|
1,
|
|
|
)
|
|
|
]
|
|
|
|
|
|
# -- Options for Texinfo output ----------------------------------------------
|
|
|
|
|
|
# Grouping the document tree into Texinfo files. List of tuples
|
|
|
# (source start file, target name, title, author,
|
|
|
# dir menu entry, description, category)
|
|
|
texinfo_documents = [
|
|
|
(
|
|
|
master_doc,
|
|
|
"actes_princiers",
|
|
|
"actes_princiers Documentation",
|
|
|
author,
|
|
|
"actes_princiers",
|
|
|
"Project actes_princiers codebase.",
|
|
|
"Data-Science",
|
|
|
)
|
|
|
]
|
|
|
|
|
|
# -- Options for todo extension ----------------------------------------------
|
|
|
|
|
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
|
todo_include_todos = False
|
|
|
|
|
|
# -- Extension configuration -------------------------------------------------
|
|
|
|
|
|
# nbsphinx_prolog = """
|
|
|
# see here for prolog/epilog details:
|
|
|
# https://nbsphinx.readthedocs.io/en/0.3.1/prolog-and-epilog.html
|
|
|
# """
|
|
|
|
|
|
# -- NBconvert kernel config -------------------------------------------------
|
|
|
nbsphinx_kernel_name = "python3"
|
|
|
|
|
|
|
|
|
def remove_arrows_in_examples(lines):
|
|
|
for i, line in enumerate(lines):
|
|
|
lines[i] = line.replace(">>>", "")
|
|
|
|
|
|
|
|
|
def autodoc_process_docstring(app, what, name, obj, options, lines):
|
|
|
remove_arrows_in_examples(lines)
|
|
|
|
|
|
|
|
|
def skip(app, what, name, obj, skip, options):
|
|
|
if name == "__init__":
|
|
|
return False
|
|
|
return skip
|
|
|
|
|
|
|
|
|
def setup(app):
|
|
|
app.connect("autodoc-process-docstring", autodoc_process_docstring)
|
|
|
app.connect("autodoc-skip-member", skip)
|
|
|
# add Kedro stylesheets
|
|
|
for stylesheet in find_stylesheets():
|
|
|
app.add_css_file(stylesheet)
|