You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
54 lines
1.1 KiB
54 lines
1.1 KiB
2 years ago
|
# Configuration file for the Sphinx documentation builder.
|
||
|
|
|
||
|
|
# -- Project information
|
||
|
|
|
||
|
|
project = 'DGEMS'
|
||
|
|
copyright = '2022'
|
||
|
|
author = 'Kenneth Jao, Qi Jian Lim'
|
||
|
|
|
||
|
|
release = '0.1'
|
||
|
|
version = '0.1.0'
|
||
|
|
|
||
|
|
# -- General configuration
|
||
|
|
|
||
|
|
html_static_path = ["_static"]
|
||
|
|
html_js_files = ["js/mathjax-config.js"]
|
||
|
|
|
||
|
|
extensions = [
|
||
|
|
'sphinx.ext.duration',
|
||
|
|
'sphinx.ext.doctest',
|
||
|
|
'sphinx.ext.autodoc',
|
||
|
|
'sphinx.ext.autosummary',
|
||
|
|
'sphinx.ext.autosectionlabel',
|
||
|
|
'sphinx.ext.intersphinx',
|
||
|
|
'sphinx.ext.mathjax',
|
||
|
|
'sphinx.ext.graphviz',
|
||
|
|
'sphinxcontrib.bibtex',
|
||
|
|
'breathe',
|
||
|
|
]
|
||
|
|
|
||
|
|
breathe_projects = {"DGEMS": "../build/xml"}
|
||
|
|
breathe_default_project = "DGEMS"
|
||
|
|
|
||
|
|
bibtex_bibfiles = ['refs.bib']
|
||
|
|
|
||
|
|
mathjax_path = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
|
||
|
|
|
||
|
|
intersphinx_mapping = {
|
||
|
|
'python': ('https://docs.python.org/3/', None),
|
||
|
|
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
|
||
|
|
}
|
||
|
|
intersphinx_disabled_domains = ['std']
|
||
|
|
|
||
|
|
templates_path = ['_templates']
|
||
|
|
|
||
|
|
# -- Options for HTML output
|
||
|
|
|
||
|
|
html_theme = 'sphinx_rtd_theme'
|
||
|
|
html_theme_options = {
|
||
|
|
'collapse_navigation': False,
|
||
|
|
}
|
||
|
|
|
||
|
|
# -- Options for EPUB output
|
||
|
|
epub_show_urls = 'footnote'
|