Skip to content
Snippets Groups Projects
Commit 5c840bb1 authored by Tamas Gal's avatar Tamas Gal :speech_balloon:
Browse files

Reactivate sphinx gallery

parent 27cc4f5c
No related branches found
No related tags found
No related merge requests found
.rst-content .highlight>pre {
line-height: 18px;
}
doc/_static/default_gallery_thumbnail.png

23.7 KiB

......@@ -35,7 +35,7 @@ author = 'Zineb Aly, Tamas Gal, Johannes Schumann'
extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.viewcode',
'autoapi.extension', 'numpydoc',
#'sphinx_gallery.gen_gallery'
'sphinx_gallery.gen_gallery'
]
autosummary_generate = True
......@@ -54,13 +54,14 @@ autoapi_options = ['members', 'undoc-members']
autoapi_include_summaries = True
# Gallery
# sphinx_gallery_conf = {
# 'backreferences_dir': 'modules/generated',
# 'examples_dirs': '../examples', # path to your example scripts
# 'gallery_dirs':
# 'auto_examples', # path to where to save gallery generated output
# 'show_memory': True,
# }
sphinx_gallery_conf = {
'backreferences_dir': 'modules/generated',
'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
'show_memory': True,
}
# -- Options for HTML output -------------------------------------------------
......@@ -73,5 +74,5 @@ 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 = "km3io {}".format(version)
......@@ -10,6 +10,7 @@
:maxdepth: 2
:caption: Contents:
examples
changelog
autoapi/index
......
matplotlib
memory_profiler
numpydoc
pillow
pytest
pytest-cov
pytest-flake8
......@@ -7,6 +9,7 @@ pytest-pylint
pytest-watch
sphinx
sphinx-autoapi
sphinx-gallery>=0.1.12
sphinx_rtd_theme
sphinxcontrib-versioning
yapf>=0.29.0
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment