| 1 |
# Configuration file for the Sphinx documentation builder. |
| 2 |
# |
| 3 |
# For the full list of built-in configuration values, see the documentation: |
| 4 |
# https://www.sphinx-doc.org/en/master/usage/configuration.html |
| 5 |
|
| 6 |
# -- Project information ----------------------------------------------------- |
| 7 |
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information |
| 8 |
|
| 9 |
project = 'ASV Memray Benchmark' |
| 10 |
copyright = '2024, Rohit Goswami' |
| 11 |
author = 'Rohit Goswami' |
| 12 |
release = '0.1.2' |
| 13 |
|
| 14 |
# -- General configuration --------------------------------------------------- |
| 15 |
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration |
| 16 |
|
| 17 |
extensions = [ |
| 18 |
"autodoc2", |
| 19 |
"myst_parser", |
| 20 |
"sphinx.ext.intersphinx", |
| 21 |
"sphinx.ext.viewcode", # Links to source code |
| 22 |
] |
| 23 |
|
| 24 |
templates_path = ['_templates'] |
| 25 |
exclude_patterns = [] |
| 26 |
|
| 27 |
autodoc2_render_plugin = 'myst' |
| 28 |
|
| 29 |
autodoc2_packages = [ |
| 30 |
"../../asv_bench_memray", |
| 31 |
] |
| 32 |
|
| 33 |
intersphinx_mapping = { |
| 34 |
"python": ("https://docs.python.org/3/", None), |
| 35 |
"sphinx": ("https://www.sphinx-doc.org/en/master", None), |
| 36 |
"asv": ("https://asv.readthedocs.io/en/latest/", None), |
| 37 |
"asv_runner": ("https://asv.readthedocs.io/projects/asv-runner/en/latest/", None), |
| 38 |
} |
| 39 |
myst_enable_extensions = ["fieldlist", "deflist"] |
| 40 |
|
| 41 |
|
| 42 |
# -- Options for HTML output ------------------------------------------------- |
| 43 |
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output |
| 44 |
|
| 45 |
html_theme = 'furo' |
| 46 |
html_static_path = ['_static'] |