-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
conf.py
120 lines (99 loc) · 3.85 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# 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 --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
# import sys
# sys.path.insert(0, os.path.abspath(os.path.join("..")))
# Needed for Read The Docs documentation setup
ENV_VARS = {
"OWID_COVID_PROJECT_DIR": {
"current": os.environ.get("OWID_COVID_PROJECT_DIR"),
"fallback": (project_dir := os.path.abspath(os.path.join(os.path.dirname(__file__), "..", ".."))),
},
"OWID_COVID_CONFIG": {
"current": os.environ.get("OWID_COVID_CONFIG"),
"fallback": os.path.join(project_dir, "scripts", "config.yaml"),
},
}
for var_name, var_values in ENV_VARS.items():
if var_values["current"] is None:
print(f"Setting env variable {var_name}")
os.environ[var_name] = var_values["fallback"]
print("----------------------------------------")
# -- Project information -----------------------------------------------------
author = "Our World in Data"
project = f"COVID-19 dataset by {author}"
copyright = "2022, Our World in Data"
# The full version, including alpha/beta/rc tags
release = "0.0.1.dev0"
# -- 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_click",
"myst_parser",
"sphinx.ext.napoleon",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.viewcode",
# "m2r2",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# source_suffix = [".rst", ".md"]
# 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"]
# -- 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 = "furo"
# 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".
html_theme_options = {
"sidebar_hide_name": True,
}
# html_static_path = ["_static"]
html_favicon = "_static/favicon.ico"
html_logo = "_static/owid.png"
# autodoc_default_options = {
# "members": True,
# # The ones below should be optional but work nicely together with
# # example_package/autodoctest/doc/source/_templates/autosummary/class.rst
# # and other defaults in sphinx-autodoc.
# "show-inheritance": True,
# "inherited-members": True,
# "no-special-members": False,
# }
autodoc_default_flags = [
"members",
"undoc-members",
"private-members",
"special-members",
"inherited-members",
"show-inheritance",
]
html_context = {
"display_github": True, # Integrate GitHub
"github_user": "owid", # Username
"github_repo": "covid-19-data", # Repo name
"github_version": "master", # Version
"conf_py_path": "/scripts/docs/", # Path in the checkout to the docs root
}
myst_enable_extensions = [
"colon_fence",
]
## API docs
from sphinx.ext.apidoc import main
main(["-f", "-t", "apidoc-templates", "-P", "-o", "cowidev/api", "../src/cowidev/"])