# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
texinfo_show_urls = 'footnote'
# -- Options for pybtex output -------------------------------------------------
# load our plugins for manual bibstyle
import pkg_resources
# temporary disable due to python3 pybtex quirks
for dist in pkg_resources.find_distributions(SPHINXDOC_PATH + "/_templates/pybtex_plugins/"):
pkg_resources.working_set.add(dist)
# End pybtex stuff
# -- Options for doxylink ------------------------------------------------------
doxylink = {
'gimliapi': (join(DOXY_BUILD_DIR, 'gimli.tag'), 'gimliapi/html/')
}
# Create small gallery of all tutorials and examples in the sidebar.
from sidebar_gallery import make_gallery
make_gallery(SPHINXDOC_PATH, DOC_BUILD_DIR)
# Documents to append as an appendix to all manuals.
# texinfo_appendices = []
# If false, no module index is generated.
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
texinfo_show_urls = 'footnote'
# -- Options for pybtex output ------------------------------------------------
# load our plugins for manual bibstyle
# temporary disable due to python3 pybtex quirks
for dist in pkg_resources.find_distributions(SPHINXDOC_PATH +
"/_templates/pybtex_plugins/"):
pkg_resources.working_set.add(dist)
# End pybtex stuff
# -- Options for doxylink -----------------------------------------------------
doxylink = {
'gimliapi': (join(DOXY_BUILD_DIR,
'gimli.tag'), 'https://www.pygimli.org/gimliapi')
}
# Create small gallery of all tutorials and examples in the sidebar.
# from pygimli.misc.sidebar_gallery import make_gallery
sys.path.insert(0, os.path.abspath('.'))
make_gallery(SPHINXDOC_PATH, DOC_BUILD_DIR)
# End pybtex stuff
# -- Options for doxylink -----------------------------------------------------
doxylink = {
'gimliapi': (join(DOXY_BUILD_DIR,
'gimli.tag'), 'https://www.pygimli.org/gimliapi')
}
# Create HTML table
from bib2html import write_html
publications = write_html()
################################################################################################
# Extra call to create small gallery of all already made tutorials and examples in the sidebar.
################################################################################################
make_gallery(os.path.abspath(SPHINXDOC_PATH), os.path.abspath(DOC_BUILD_DIR))
# Add carousel to start page
from paper_carousel import showcase
random.shuffle(showcase) # mix it up
html_context = {"showcase": showcase, "publications": publications}
srclink_project = 'https://github.com/gimli-org/gimli'
srclink_src_path = 'doc/'
srclink_branch = 'dev'
# New docstring parsing using Napoleon instead of numpydoc
# The monkeypatch detects draw or show commands
from sphinx.ext.napoleon import NumpyDocstring