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
|
# icalendar documentation build configuration file
import importlib.metadata
import datetime
import os
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.coverage",
"sphinx.ext.viewcode",
"sphinx_copybutton",
"sphinx.ext.intersphinx",
"sphinx.ext.autosectionlabel",
"sphinx.ext.napoleon",
]
source_suffix = ".rst"
master_doc = "index"
project = "icalendar"
this_year = datetime.date.today().year
copyright = f"{this_year}, Plone Foundation"
if "DEB_VERSION_UPSTREAM" in os.environ:
version = os.environ["DEB_VERSION_UPSTREAM"]
else:
version = importlib.metadata.version("icalendar")
release = version
# -- 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"
html_theme_options = {
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/collective/icalendar",
"icon": "fa-brands fa-square-github",
"type": "fontawesome",
"attributes": {
"target": "_blank",
"rel": "noopener me",
"class": "nav-link custom-fancy-css"
}
},
{
"name": "PyPI",
"url": "https://pypi.org/project/icalendar",
"icon": "fa-custom fa-pypi",
"type": "fontawesome",
"attributes": {
"target": "_blank",
"rel": "noopener me",
"class": "nav-link custom-fancy-css"
}
},
],
"navigation_with_keys": True,
"search_bar_text": "Search",
"show_nav_level": 2,
"show_toc_level": 2,
"use_edit_page_button": True,
}
pygments_style = "sphinx"
html_context = {
# "github_url": "https://github.com", # or your GitHub Enterprise site
"github_user": "collective",
"github_repo": "icalendar",
"github_version": "main",
"doc_path": "docs",
}
htmlhelp_basename = "icalendardoc"
# -- Intersphinx configuration ----------------------------------
# This extension can generate automatic links to the documentation of objects
# in other projects. Usage is simple: whenever Sphinx encounters a
# cross-reference that has no matching target in the current documentation set,
# it looks for targets in the documentation sets configured in
# intersphinx_mapping. A reference like :py:class:`zipfile.ZipFile` can then
# linkto the Python documentation for the ZipFile class, without you having to
# specify where it is located exactly.
#
# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
}
man_pages = [("index", "icalendar", "icalendar Documentation", ["Plone Foundation"], 1)]
|
