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
|
# 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('.'))
import sys
from pathlib import Path
import psycopg
docs_dir = Path(__file__).parent
sys.path.append(str(docs_dir / "lib"))
# -- Project information -----------------------------------------------------
project = "psycopg"
copyright = "2020, Daniele Varrazzo and The Psycopg Team"
author = "Daniele Varrazzo"
release = psycopg.__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.intersphinx",
# Currently breaking docs link (see #562)
# "sphinx_autodoc_typehints",
"sql_role",
"ticket_role",
"pg3_docs",
]
# 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", ".venv"]
# -- Options for HTML output -------------------------------------------------
# The announcement may be in the website but not shipped with the docs
if (ann_file := (docs_dir / "../../templates/docs3-announcement.html")).exists():
with ann_file.open() as f:
announcement = f.read()
else:
announcement = ""
html_css_files = ["psycopg.css"]
# The name of the Pygments (syntax highlighting) style to use.
# Some that I've check don't suck:
# default lovelace tango algol_nu
# list: from pygments.styles import STYLE_MAP; print(sorted(STYLE_MAP.keys()))
pygments_style = "tango"
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = "furo"
html_show_sphinx = True
html_show_sourcelink = False
html_theme_options = {
"announcement": announcement,
"sidebar_hide_name": False,
"light_logo": "psycopg.svg",
"dark_logo": "psycopg.svg",
"light_css_variables": {"admonition-font-size": "1rem"},
}
# 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_static_path = ["_static"]
# The reST default role (used for this markup: `text`) to use for all documents.
default_role = "obj"
intersphinx_mapping = {
"py": ("file:///usr/share/doc/python3-doc/html/",
"/usr/share/doc/python3-doc/html/objects.inv"),
"pg2": ("file:///usr/share/doc/python-psycopg2-doc/html/",
"/usr/share/doc/python-psycopg2-doc/html/objects.inv"),
"numpy": ("file:///usr/share/doc/python-numpy/html/",
"/usr/share/doc/python-numpy/html/objects.inv"),
}
autodoc_member_order = "bysource"
# PostgreSQL docs version to link libpq functions to
libpq_docs_version = "18"
# Where to point on :ticket: role
ticket_url = "https://github.com/psycopg/psycopg/issues/%s"
|
