mirror of
https://github.com/cp2k/cp2k.git
synced 2026-07-28 06:05:29 -04:00
50 lines
1.5 KiB
Python
50 lines
1.5 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# For the full list of built-in configuration values, see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = "CP2K"
|
|
copyright = "2000-2024, CP2K Developers"
|
|
author = "CP2K Developers"
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = ["myst_parser", "sphinx_rtd_theme", "sphinx.ext.mathjax"]
|
|
|
|
myst_enable_extensions = [
|
|
"attrs_inline",
|
|
"dollarmath",
|
|
"smartquotes",
|
|
"strikethrough",
|
|
]
|
|
|
|
templates_path = ["_templates"]
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "README.md"]
|
|
|
|
suppress_warnings = ["ref"]
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_static_path = ["_static"]
|
|
html_favicon = "_static/favicon.png"
|
|
html_copy_source = False
|
|
|
|
add_module_names = False
|
|
|
|
# https://myst-parser.readthedocs.io/en/v0.16.1/syntax/optional.html#syntax-header-anchors
|
|
|
|
html_context = {
|
|
"display_github": True,
|
|
"github_user": "cp2k",
|
|
"github_repo": "cp2k",
|
|
"github_version": "master",
|
|
"conf_py_path": "/docs/",
|
|
}
|
|
|
|
# EOF
|