sphinxcontrib-waterloo-docstrings 0.3.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. sphinxcontrib/waterloo_docstrings/__init__.py +17 -0
  2. sphinxcontrib/waterloo_docstrings/_static/common_styles.css +293 -0
  3. sphinxcontrib/waterloo_docstrings/_static/waterloo_base.css +530 -0
  4. sphinxcontrib/waterloo_docstrings/extension.py +2781 -0
  5. sphinxcontrib_waterloo_docstrings-0.3.1.dist-info/METADATA +103 -0
  6. sphinxcontrib_waterloo_docstrings-0.3.1.dist-info/RECORD +9 -0
  7. sphinxcontrib_waterloo_docstrings-0.3.1.dist-info/WHEEL +5 -0
  8. sphinxcontrib_waterloo_docstrings-0.3.1.dist-info/licenses/LICENSE +24 -0
  9. sphinxcontrib_waterloo_docstrings-0.3.1.dist-info/top_level.txt +1 -0
sphinxcontrib/waterloo_docstrings/__init__.py ADDED
@@ -0,0 +1,17 @@
1
+ from importlib.metadata import PackageNotFoundError, version
2
+
3
+ try:
4
+ __version__ = version("sphinxcontrib-waterloo-docstrings")
5
+ except PackageNotFoundError:
6
+ __version__ = "0.0.0"
7
+
8
+
9
+ def setup(app):
10
+ # Lazy import because sphinx is marked as optional dependency
11
+ # in pyproject.toml. The user should actively install sphinx.
12
+ from .extension import setup as extension_setup
13
+
14
+ return extension_setup(app)
15
+
16
+
17
+ __all__ = ["__version__", "setup"]
sphinxcontrib/waterloo_docstrings/_static/common_styles.css ADDED
@@ -0,0 +1,293 @@
1
+ /*
2
+ We define common styles across languages. Ideally these coincide
3
+ more or less with those used in markup2. This is possible because
4
+ we are moving away from highlight and implement our own stuff.
5
+ Although highlight is brilliant, we prefer the inhouse solution
6
+ becaues it allows more control and has a well-known C++ API.
7
+
8
+ Current state [2023-08-08]
9
+ - glsl
10
+ - cpp
11
+ - minil
12
+ - xml
13
+ - python
14
+ */
15
+
16
+ :root {
17
+ /* 1. Etwas kleinere Schrift macht die Box kompakter und hebt sie optisch an */
18
+ --font-size--code: 0.875em;
19
+
20
+ /* 2. Falls installiert: Furo bevorzugt eigentlich Fira Code oder JetBrains Mono.
21
+ Indem wir moderne Programmierschriften nach vorne stellen, nutzt Firefox
22
+ bessere Schriftmetriken, falls du sie auf dem System hast. */
23
+ --font-stack--monospace: "JetBrains Mono", "Fira Code", "Fira Mono", "Menlo", "Consolas", monospace;
24
+ }
25
+
26
+ /* 3. Korrektur des Innenabstands (Padding) speziell f�r Firefox/Linux */
27
+ code.docutils.literal {
28
+ vertical-align: 0.06em;
29
+ font-size:95%;
30
+ }
31
+
32
+ :root
33
+ {
34
+ --sdv-plain-color:inherit;
35
+ --sdv-plain-font-weight:normal;
36
+ --sdv-plain-font-style:normal;
37
+
38
+ --sdv-attr-color:#077;
39
+ --sdv-attr-font-weight:normal;
40
+ --sdv-attr-font-style:normal;
41
+
42
+ --sdv-cmd-color:#996600;
43
+ --sdv-cmd-font-weight:normal;
44
+ --sdv-cmd-font-style:normal;
45
+
46
+ --sdv-class-color:#770000;
47
+ --sdv-class-font-weight:normal;
48
+ --sdv-class-font-style:normal;
49
+
50
+ --sdv-comment-color:#777;
51
+ --sdv-comment-font-weight:normal;
52
+ --sdv-comment-font-style:italic;
53
+
54
+ --sdv-dfn-color:inherit;
55
+ --sdv-dfn-font-weight:inherit;
56
+ --sdv-dfn-font-style:italic;
57
+
58
+ --sdv-func-color:#3040ff;
59
+ --sdv-func-font-weight:normal;
60
+ --sdv-func-font-style:normal;
61
+
62
+ --sdv-number-color:#708238;
63
+ --sdv-number-font-weight:normal;
64
+ --sdv-number-font-style:normal;
65
+
66
+ --sdv-value-color:#004400;
67
+ --sdv-value-font-weight:normal;
68
+ --sdv-value-font-style:normal;
69
+
70
+ --sdv-preprocessor-color:#000055;
71
+ --sdv-preprocessor-font-weight:normal;
72
+ --sdv-preprocessor-font-style:normal;
73
+
74
+ --sdv-string-literal-color:#708238;
75
+ --sdv-string-literal-font-weight:normal;
76
+ --sdv-string-literal-font-style:normal;
77
+
78
+ --sdv-file-font-weight: normal;
79
+ --sdv-file-font-style: normal;
80
+ --sdv-file-color: #35f;
81
+
82
+ --sdv-key-color:inherit;
83
+ --sdv-key-font-weight:normal;
84
+ --sdv-key-font-style:normal;
85
+
86
+ --sdv-label-color:inherit;
87
+ --sdv-label-font-weight:normal;
88
+ --sdv-label-font-style:oblique;
89
+
90
+ --sdv-mod-color:#462;
91
+ --sdv-mod-font-weight:normal;
92
+ --sdv-mod-font-style:normal;
93
+
94
+ --sdv-norm-color:inherit;
95
+ --sdv-norm-font-weight:normal;
96
+ --sdv-norm-font-style:italic;
97
+
98
+ --sdv-op-color:inherit;
99
+ --sdv-op-font-weight:bold;
100
+ --sdv-op-font-style:normal;
101
+
102
+ --sdv-opt-color:inherit;
103
+ --sdv-opt-font-weight:bold;
104
+ --sdv-opt-font-style:normal;
105
+
106
+ --sdv-pkg-color:#304030;
107
+ --sdv-pkg-font-weight:normal;
108
+ --sdv-pkg-font-style:normal;
109
+
110
+ --sdv-tag-color:#900;
111
+ --sdv-tag-font-weight:normal;
112
+ --sdv-tag-font-style:normal;
113
+
114
+ --sdv-term-color:inherit;
115
+ --sdv-term-font-weight:normal;
116
+ --sdv-term-font-style:italic;
117
+
118
+ --sdv-type-color:#770000;
119
+ --sdv-type-font-weight:normal;
120
+ --sdv-type-font-style:normal;
121
+
122
+ --sdv-url-font-weight: normal;
123
+ --sdv-url-font-style: normal;
124
+ --sdv-url-color: #35f;;
125
+
126
+ --sdv-var-color:#a00;
127
+ --sdv-var-font-weight:normal;
128
+ --sdv-var-font-style:normal;
129
+
130
+ /* don't know */
131
+ --sdv-variable-color:#077;
132
+ --sdv-variable-font-weight:normal;
133
+ --sdv-variable-font-style:normal;
134
+
135
+ /* shit */
136
+ --sdv-string_literal-color:#708238;
137
+ --sdv-string_literal-font-weight:normal;
138
+ --sdv-string_literal-font-style:normal;
139
+
140
+ --sdv-keyword-color:#000000;
141
+ --sdv-keyword-font-weight:bold;
142
+ --sdv-keyword-font-style:normal;
143
+
144
+ --sdv-storage-color:#aa0000;
145
+ --sdv-storage-font-weight:normal;
146
+ --sdv-storage-font-style:normal;
147
+
148
+ --sdv-func_call-color:#00d;
149
+ --sdv-func_call-font-weight:normal;
150
+ --sdv-func_call-font-style:normal;
151
+
152
+ --sdv-builtin_func_call-color:#00d;
153
+ --sdv-builtin_func_call-font-weight:bold;
154
+ --sdv-builtin_func_call-font-style:normal;
155
+
156
+
157
+
158
+
159
+ --sdv-typedesc-color:#00f;
160
+ --sdv-typedesc-font-weight:bold;
161
+ --sdv-typedesc-font-style:normal;
162
+
163
+ --sdv-reserved-color:#aa5500;
164
+ --sdv-reserved-font-weight:normal;
165
+ --sdv-reserved-font-style:normal;
166
+
167
+ --sdv-placeholder-color:#005500;
168
+ --sdv-placeholder-font-weight:normal;
169
+ --sdv-placeholder-font-style:normal;
170
+
171
+ --sdv-decorator-color:#aa0000;
172
+ --sdv-decorator-font-weight:normal;
173
+ --sdv-decorator-font-style:normal;
174
+ /* xml */
175
+ --sdv-procinst-color:#000;
176
+ --sdv-procinst-font-weight:bold;
177
+ --sdv-procinst-font-style:normal;
178
+
179
+
180
+ --sdv-cdata-color:#000;
181
+ --sdv-cdata-font-weight:bold;
182
+ --sdv-cdata-font-style:normal;
183
+
184
+ --sdv-entity-color:#777;
185
+ --sdv-entity-font-weight:bold;
186
+ --sdv-entity-font-style:normal;
187
+ /* markup2 */
188
+ --sdv-escseq-color:#cd212a;
189
+ --sdv-escseq-font-weight:normal;
190
+ --sdv-escseq-font-style:normal;
191
+
192
+ --sdv-verbatim-color:#ff7f00;
193
+ --sdv-verbatim-font-weight:bold;
194
+ --sdv-verbatim-font-style:normal;
195
+ /* nft */
196
+ --sdv-command-color:#bb0000;
197
+ --sdv-command-font-weight:normal;
198
+ --sdv-command-font-style:normal;
199
+
200
+ --sdv-structure-color:#007700;
201
+ --sdv-structure-font-weight:normal;
202
+ --sdv-structure-font-style:normal;
203
+
204
+ --sdv-match-color:#000000;
205
+ --sdv-match-font-weight:bold;
206
+ --sdv-match-font-style:normal;
207
+
208
+ --sdv-member-color:#aaaa00;
209
+ --sdv-member-font-weight:normal;
210
+ --sdv-member-font-style:italic;
211
+
212
+ --sdv-reference-color:#aa0000;
213
+ --sdv-reference-font-weight:bold;
214
+ --sdv-reference-font-style:normal;
215
+
216
+ --sdv-address-family-color:#cc7700;
217
+ --sdv-address-family-font-weight:normal;
218
+ --sdv-address-family-font-style:normal;
219
+
220
+ --sdv-verdict-statement-color:#0077ff;
221
+ --sdv-verdict-statement-font-weight:bold;
222
+ --sdv-verdict-statement-font-style:normal;
223
+ }
224
+
225
+ /* Furo stores the active theme on body, not on :root. */
226
+ :root {
227
+ --sdv-dark-attr-color:#099;
228
+ --sdv-dark-class-color:#e66;
229
+ --sdv-dark-cmd-color:#cc8800;
230
+ --sdv-dark-comment-color:#777;
231
+ --sdv-dark-func-color:#6090ff;
232
+ --sdv-dark-number-color:#708238;
233
+ --sdv-dark-preprocessor-color:#000055;
234
+ --sdv-dark-string-literal-color:#708238;
235
+ --sdv-dark-file-color: #7af;
236
+ --sdv-dark-label-color:var(--color-foreground-primary);
237
+ --sdv-dark-mod-color:#8c4;
238
+ --sdv-dark-pkg-color:#8b8;
239
+ --sdv-dark-pkg-font-weight:normal;
240
+ --sdv-dark-pkg-font-style:normal;
241
+ --sdv-dark-tag-color:#e44;
242
+ --sdv-dark-type-color:#e66;
243
+ --sdv-dark-url-color: #7af;
244
+ --sdv-dark-value-color:#8c4;
245
+ --sdv-dark-var-color:#f34;
246
+ }
247
+
248
+ body[data-theme="dark"] {
249
+ --sdv-attr-color:var(--sdv-dark-attr-color);
250
+ --sdv-class-color:var(--sdv-dark-class-color);
251
+ --sdv-cmd-color:var(--sdv-dark-cmd-color);
252
+ --sdv-comment-color:var(--sdv-dark-comment-color);
253
+ --sdv-func-color:var(--sdv-dark-func-color);
254
+ --sdv-number-color:var(--sdv-dark-number-color);
255
+ --sdv-preprocessor-color:var(--sdv-dark-preprocessor-color);
256
+ --sdv-string-literal-color:var(--sdv-dark-string-literal-color);
257
+ --sdv-file-color:var(--sdv-dark-file-color);
258
+ --sdv-label-color:var(--sdv-dark-label-color);
259
+ --sdv-mod-color:var(--sdv-dark-mod-color);
260
+ --sdv-pkg-color:var(--sdv-dark-pkg-color);
261
+ --sdv-pkg-font-weight:var(--sdv-dark-pkg-font-weight);
262
+ --sdv-pkg-font-style:var(--sdv-dark-pkg-font-style);
263
+ --sdv-tag-color:var(--sdv-dark-tag-color);
264
+ --sdv-type-color:var(--sdv-dark-type-color);
265
+ --sdv-url-color:var(--sdv-dark-url-color);
266
+ --sdv-value-color:var(--sdv-dark-value-color);
267
+ --sdv-var-color:var(--sdv-dark-var-color);
268
+ }
269
+
270
+ @media (prefers-color-scheme: dark) {
271
+ :root,
272
+ body[data-theme="auto"] {
273
+ --sdv-attr-color:var(--sdv-dark-attr-color);
274
+ --sdv-class-color:var(--sdv-dark-class-color);
275
+ --sdv-cmd-color:var(--sdv-dark-cmd-color);
276
+ --sdv-comment-color:var(--sdv-dark-comment-color);
277
+ --sdv-func-color:var(--sdv-dark-func-color);
278
+ --sdv-number-color:var(--sdv-dark-number-color);
279
+ --sdv-preprocessor-color:var(--sdv-dark-preprocessor-color);
280
+ --sdv-string-literal-color:var(--sdv-dark-string-literal-color);
281
+ --sdv-file-color:var(--sdv-dark-file-color);
282
+ --sdv-label-color:var(--sdv-dark-label-color);
283
+ --sdv-mod-color:var(--sdv-dark-mod-color);
284
+ --sdv-pkg-color:var(--sdv-dark-pkg-color);
285
+ --sdv-pkg-font-weight:var(--sdv-dark-pkg-font-weight);
286
+ --sdv-pkg-font-style:var(--sdv-dark-pkg-font-style);
287
+ --sdv-tag-color:var(--sdv-dark-tag-color);
288
+ --sdv-type-color:var(--sdv-dark-type-color);
289
+ --sdv-url-color:var(--sdv-dark-url-color);
290
+ --sdv-value-color:var(--sdv-dark-value-color);
291
+ --sdv-var-color:var(--sdv-dark-var-color);
292
+ }
293
+ }