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
121
122
123
124
125
126
127
128
|
import os
from sphinx.util import logging
from sphinx.util.console import bold
from sphinx.util.osutil import copyfile
from .docutils import ChangeDirective
from .docutils import ChangeLogDirective
from .docutils import ChangeLogImportDirective
from .docutils import make_ticket_link
from .environment import Environment
try:
from sphinx.util.display import status_iterator
except ImportError:
from sphinx.util import status_iterator
LOG = logging.getLogger(__name__)
def _is_html(app):
return app.builder.name in ("html", "readthedocs")
class SphinxEnvironment(Environment):
__slots__ = ("sphinx_env",)
@classmethod
def from_document_settings(cls, settings):
return SphinxEnvironment(settings.env)
def __init__(self, sphinx_env):
self.sphinx_env = sphinx_env
def log_debug(self, msg, *args):
LOG.debug(msg, *args)
@property
def temp_data(self):
return self.sphinx_env.temp_data
@property
def changelog_sections(self):
return self.sphinx_env.config.changelog_sections
@property
def changelog_caption_class(self):
return self.sphinx_env.config.changelog_caption_class
@property
def changelog_inner_tag_sort(self):
return self.sphinx_env.config.changelog_inner_tag_sort
@property
def changelog_hide_sections_from_tags(self):
return self.sphinx_env.config.changelog_hide_sections_from_tags
@property
def changelog_hide_tags_in_entry(self):
return self.sphinx_env.config.changelog_hide_tags_in_entry
@property
def changelog_render_ticket(self):
return self.sphinx_env.config.changelog_render_ticket
@property
def changelog_render_pullreq(self):
return self.sphinx_env.config.changelog_render_pullreq
@property
def changelog_render_changeset(self):
return self.sphinx_env.config.changelog_render_changeset
def status_iterator(self, elements, message):
return status_iterator(
elements,
message,
"purple",
length=len(elements),
verbosity=self.sphinx_env.app.verbosity,
)
def add_stylesheet(app):
# changed in 1.8 from add_stylesheet()
# https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_css_file
app.add_css_file("changelog.css")
def copy_stylesheet(app, exception):
LOG.info(
bold("The name of the builder is: %s" % app.builder.name), nonl=True
)
if not _is_html(app) or exception:
return
LOG.info(bold("Copying sphinx_paramlinks stylesheet... "), nonl=True)
source = os.path.abspath(os.path.dirname(__file__))
# the '_static' directory name is hardcoded in
# sphinx.builders.html.StandaloneHTMLBuilder.copy_static_files.
# would be nice if Sphinx could improve the API here so that we just
# give it the path to a .css file and it does the right thing.
dest = os.path.join(app.builder.outdir, "_static", "changelog.css")
copyfile(os.path.join(source, "changelog.css"), dest)
LOG.info("done")
def setup(app):
Environment.register(SphinxEnvironment)
app.add_directive("changelog", ChangeLogDirective)
app.add_directive("change", ChangeDirective)
app.add_directive("changelog_imports", ChangeLogImportDirective)
app.add_config_value("changelog_sections", [], "env")
app.add_config_value("changelog_caption_class", "caption", "env")
app.add_config_value("changelog_inner_tag_sort", [], "env")
app.add_config_value("changelog_hide_sections_from_tags", False, "env")
app.add_config_value("changelog_hide_tags_in_entry", False, "env")
app.add_config_value("changelog_render_ticket", None, "env")
app.add_config_value("changelog_render_pullreq", None, "env")
app.add_config_value("changelog_render_changeset", None, "env")
app.connect("builder-inited", add_stylesheet)
app.connect("build-finished", copy_stylesheet)
app.add_role("ticket", make_ticket_link)
return {"parallel_read_safe": True, "parallel_write_safe": True}
|
