mirror of
https://github.com/RRZE-HPC/OSACA.git
synced 2025-09-05 17:30:47 +02:00
68 lines
2.2 KiB
Python
68 lines
2.2 KiB
Python
# -- Path setup --------------------------------------------------------------
|
|
|
|
# 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 os
|
|
import sys
|
|
|
|
|
|
sys.path.insert(0, os.path.abspath('.'))
|
|
from version_from_src import get_version
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'OSACA'
|
|
copyright = '2020, Jan Laukemann'
|
|
author = 'Jan Laukemann'
|
|
html_logo = 'img/osaca-logo.png'
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
version = get_version()
|
|
release = get_version()
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# 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.doctest',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx.ext.mathjax',
|
|
'sphinx.ext.napoleon',
|
|
'sphinx.ext.todo',
|
|
'sphinx.ext.viewcode',
|
|
]
|
|
|
|
add_module_names = False
|
|
source_suffix = '.rst'
|
|
master_doc = 'index'
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
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 = []
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
# e.g., 'alabaster', 'sphinx_rtd_theme'
|
|
html_theme = 'sphinx_rtd_theme'
|
|
|
|
# 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 = []
|
|
htmlhelp_basename = 'osaca_doc'
|
|
html_sidebars = {'**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']}
|
|
|
|
autodoc_member_order = 'bysource'
|