Skip to content
Snippets Groups Projects

Another dev

Closed Mikhail Smirnov requested to merge another-dev into main
9 files
+ 424
19
Compare changes
  • Side-by-side
  • Inline
Files
9
+ 20
18
@@ -21,11 +21,11 @@ from pkg_resources import get_distribution
# -- Project information -----------------------------------------------------
version = get_distribution('km3irf').version
short_version = '.'.join(version.split('.')[:2])
project = 'km3irf {}'.format(short_version)
copyright = '{0}, Tamas Gal'.format(date.today().year)
author = 'Tamas Gal'
version = get_distribution("km3irf").version
short_version = ".".join(version.split(".")[:2])
project = "km3irf {}".format(short_version)
copyright = "{0}, Tamas Gal".format(date.today().year)
author = "Tamas Gal"
# -- General configuration ---------------------------------------------------
@@ -33,32 +33,34 @@ author = 'Tamas Gal'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.viewcode',
'autoapi.extension', 'numpydoc',
'sphinx_gallery.gen_gallery'
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.viewcode",
"autoapi.extension",
"numpydoc",
"sphinx_gallery.gen_gallery",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]
# 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', 'Thumbs.db', '.DS_Store', 'version.py']
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "version.py"]
# AutoAPI
autoapi_type = "python"
autoapi_dirs = ['../src/km3irf']
autoapi_dirs = ["../src/km3irf"]
autoapi_options = ["members", "undoc-members", "show-module-summary"]
autoapi_include_summaries = True
# Gallery
sphinx_gallery_conf = {
'backreferences_dir': 'gen_modules',
'default_thumb_file': '_static/default_gallery_thumbnail.png',
'examples_dirs': '../examples', # path to your example scripts
'gallery_dirs':
'auto_examples', # path to where to save gallery generated output
"backreferences_dir": "gen_modules",
"default_thumb_file": "_static/default_gallery_thumbnail.png",
"examples_dirs": "../examples", # path to your example scripts
"gallery_dirs": "auto_examples", # path to where to save gallery generated output
}
# -- Options for HTML output -------------------------------------------------
@@ -66,11 +68,11 @@ sphinx_gallery_conf = {
# 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 = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# 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"]
html_title = "km3irf {}".format(version)
Loading