Jpp 21.0.0
the software that should make you happy
Loading...
Searching...
No Matches
conf Namespace Reference

Variables

 version = get_distribution("km3net_testdata").version
 
str short_version = ".".join(version.split(".")[:2])
 
str project = "km3net_testdata {}".format(short_version)
 
str copyright = "{0}, Tamas Gal".format(date.today().year)
 
str author = "Tamas Gal"
 
list extensions
 
list templates_path = ["_templates"]
 
list exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "version.py"]
 
str autoapi_type = "python"
 
list autoapi_dirs = ["../km3net_testdata"]
 
list autoapi_ignore = ["*version.py*"]
 
bool autoapi_add_toctree_entry = True
 
dict sphinx_gallery_conf
 
str html_theme = "sphinx_rtd_theme"
 
list html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
list html_static_path = ["_static"]
 
str html_title = "km3net_testdata {}".format(version)
 

Variable Documentation

◆ version

conf.version = get_distribution("km3net_testdata").version

Definition at line 27 of file conf.py.

◆ short_version

str conf.short_version = ".".join(version.split(".")[:2])

Definition at line 28 of file conf.py.

◆ project

str conf.project = "km3net_testdata {}".format(short_version)

Definition at line 29 of file conf.py.

◆ copyright

str conf.copyright = "{0}, Tamas Gal".format(date.today().year)

Definition at line 30 of file conf.py.

◆ author

str conf.author = "Tamas Gal"

Definition at line 31 of file conf.py.

◆ extensions

list conf.extensions
Initial value:
1= [
2 "sphinx.ext.autodoc",
3 "sphinx.ext.autosummary",
4 "sphinx.ext.viewcode",
5 "autoapi.extension",
6 "numpydoc",
7 "sphinx_gallery.gen_gallery",
8]

Definition at line 38 of file conf.py.

◆ templates_path

list conf.templates_path = ["_templates"]

Definition at line 48 of file conf.py.

◆ exclude_patterns

list conf.exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "version.py"]

Definition at line 53 of file conf.py.

◆ autoapi_type

str conf.autoapi_type = "python"

Definition at line 56 of file conf.py.

◆ autoapi_dirs

list conf.autoapi_dirs = ["../km3net_testdata"]

Definition at line 57 of file conf.py.

◆ autoapi_ignore

list conf.autoapi_ignore = ["*version.py*"]

Definition at line 58 of file conf.py.

◆ autoapi_add_toctree_entry

bool conf.autoapi_add_toctree_entry = True

Definition at line 59 of file conf.py.

◆ sphinx_gallery_conf

dict conf.sphinx_gallery_conf
Initial value:
1= {
2 "backreferences_dir": "modules/generated",
3 "default_thumb_file": "_static/default_gallery_thumbnail.png",
4 "examples_dirs": "../examples", # path to your example scripts
5 "gallery_dirs": "auto_examples", # path to where to save gallery generated output
6 "show_memory": True,
7}

Definition at line 62 of file conf.py.

◆ html_theme

str conf.html_theme = "sphinx_rtd_theme"

Definition at line 75 of file conf.py.

◆ html_theme_path

list conf.html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

Definition at line 76 of file conf.py.

◆ html_static_path

list conf.html_static_path = ["_static"]

Definition at line 81 of file conf.py.

◆ html_title

str conf.html_title = "km3net_testdata {}".format(version)

Definition at line 82 of file conf.py.