/
conf.py
105 lines (79 loc) · 3.1 KB
/
conf.py
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
from __future__ import annotations
import sys
from pathlib import Path
from hepstats import __version__ as version
project_dir = Path(__file__).parents[1]
sys.path.insert(0, str(project_dir))
# -- Project information -----------------------------------------------------
project = "hepstats"
copyright = "2020, Matthieu Marinangeli"
author = "Matthieu Marinangeli"
# The full version, including alpha/beta/rc tags
release = version
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.mathjax",
"sphinx.ext.ifconfig",
"sphinx.ext.githubpages",
"sphinx.ext.viewcode",
"sphinx.ext.napoleon",
"sphinx.ext.autosummary",
"sphinx.ext.inheritance_diagram",
"sphinxcontrib.bibtex",
"matplotlib.sphinxext.plot_directive",
"sphinx_copybutton",
"sphinx_autodoc_typehints",
]
bibtex_bibfiles = [
str(project_dir / "docs" / "bib" / "references.bib")
] # TODO: currently string, Path doesn't work: https://github.com/mcmtroffaes/sphinxcontrib-bibtex/issues/314
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "pydata_sphinx_theme"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
copybutton_prompt_text = ">>> "
# -- autodoc settings ---------------------------------------------
# also doc __init__ docstrings
autoclass_content = "both"
autodoc_member_order = "bysource"
autodoc_default_options = {
"show-inheritance": True,
}
autodoc_inherit_docstrings = False
html_static_path = [] # "_static"
html_logo = "images/logo.png"
html_theme_options = {
"github_url": "https://github.com/scikit-hep/hepstats",
"use_edit_page_button": True,
"search_bar_text": "Search hepstats...",
"navigation_with_keys": True,
"search_bar_position": "sidebar",
}
html_context = {
"github_user": "scikit-hep",
"github_repo": "hepstats",
"github_version": "master",
"doc_path": "docs",
}