mirror of
https://github.com/DataDog/go-profiler-notes.git
synced 2026-06-21 00:46:51 +08:00
52 lines
1.7 KiB
Python
52 lines
1.7 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
|
|
|
|
import sphinx_rtd_theme
|
|
|
|
project = 'go-profiler-notes'
|
|
copyright = '2022, Datadog'
|
|
author = 'Felix Geisendörfer, Nick Ripley'
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = ['sphinx_rtd_theme', 'sphinxemoji.sphinxemoji']
|
|
|
|
templates_path = ['_templates']
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
numfig = True
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_context = {
|
|
"display_github": True,
|
|
"github_user": "DataDog",
|
|
"github_repo": "go-profiler-notes",
|
|
"github_version": "sphinx",
|
|
"conf_py_path": "/docs/",
|
|
}
|
|
html_theme = 'sphinx_rtd_theme'
|
|
html_theme_options = {
|
|
'style_nav_header_background': '#5C2EA0',
|
|
'collapse_navigation': False,
|
|
'navigation_depth': 5,
|
|
'includehidden': False,
|
|
}
|
|
html_static_path = ['_static']
|
|
html_css_files = ['css/custom.css']
|
|
html_show_sphinx = False
|
|
html_show_copyright = False
|
|
|
|
# Workaround for html_css_files not getting updated on incremental builds.
|
|
# https://github.com/sphinx-doc/sphinx/issues/2090#issuecomment-572902572
|
|
def env_get_outdated(app, env, added, changed, removed):
|
|
return ['index']
|
|
def setup(app):
|
|
app.connect('env-get-outdated', env_get_outdated)
|