forked from jazzband/pip-tools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
conf.py
60 lines (40 loc) · 1.49 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
# https://www.sphinx-doc.org/en/master/usage/configuration.html
"""Configuration file for the Sphinx documentation builder."""
from __future__ import annotations
from functools import partial
from pathlib import Path
from setuptools_scm import get_version
# -- Path setup --------------------------------------------------------------
PROJECT_ROOT_DIR = Path(__file__).parents[1].resolve()
get_scm_version = partial(get_version, root=PROJECT_ROOT_DIR)
# -- Project information -----------------------------------------------------
project = "pip-tools"
author = f"{project} Contributors"
copyright = f"The {author}"
# The short X.Y version
version = ".".join(
get_scm_version(
local_scheme="no-local-version",
).split(
"."
)[:3],
)
# The full version, including alpha/beta/rc tags
release = get_scm_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 = ["myst_parser"]
# -- 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"
# -------------------------------------------------------------------------
default_role = "any"
nitpicky = True
linkcheck_ignore = [
r'^https://matrix\.to/#',
]
suppress_warnings = ["myst.xref_missing"]