1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
import os
import shutil
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = "asv_runner"
copyright = "2023--present, asv Developers"
author = "asv Developers"
release = "0.2.1"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
"myst_parser",
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"sphinx.ext.todo",
"sphinx_contributors",
"sphinx_copybutton",
"sphinx_design",
"sphinxcontrib.spelling",
]
autodoc2_render_plugin = "myst"
autodoc2_packages = [
"../../asv_runner",
]
myst_enable_extensions = [
"deflist",
]
intersphinx_mapping = {
"python": ("/usr/share/doc/python3-doc/html", None),
"asv": ("/usr/share/doc/python-asv-runner-doc/html", None),
}
templates_path = ["_templates"]
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "furo"
html_static_path = ["_static"]
#html_theme_options = {
# "source_repository": "https://github.com/HaoZeke/asv_runner/",
# "source_branch": "main",
# "source_directory": "docs/",
#}
# ------------- Copying things
docs_source_dir = os.path.abspath(os.path.dirname(__file__))
project_root_dir = os.path.abspath(os.path.join(docs_source_dir, "..", ".."))
changelog_src = os.path.join(project_root_dir, "CHANGELOG.md")
changelog_dest = os.path.join(docs_source_dir, "CHANGELOG.md")
shutil.copyfile(changelog_src, changelog_dest)
|
