doxysphinx 3.3.6__tar.gz → 3.3.8__tar.gz
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.
- doxysphinx-3.3.8/NOTICE.md +46 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/PKG-INFO +4 -3
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/doxygen.py +22 -8
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/pyproject.toml +4 -3
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/LICENSE.md +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/README.md +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/__init__.py +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/__main__.py +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/cli.py +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/html_parser.py +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/process.py +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/resources/custom.scss +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/resources/toc_template.html.j2 +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/resources.py +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/sphinx.py +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/toc.py +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/utils/__init__.py +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/utils/contexts.py +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/utils/exceptions.py +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/utils/files.py +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/utils/iterators.py +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/utils/pathlib_fix.py +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/utils/rst.py +0 -0
- {doxysphinx-3.3.6 → doxysphinx-3.3.8}/doxysphinx/writer.py +0 -0
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Notice
|
|
2
|
+
|
|
3
|
+
## Intro
|
|
4
|
+
|
|
5
|
+
This is the official list of Doxysphinx copyright holders and authors.
|
|
6
|
+
|
|
7
|
+
Often employers or academic institutions have ownership over code that is
|
|
8
|
+
written in certain circumstances, so please do due diligence to ensure that
|
|
9
|
+
you have the right to submit the code.
|
|
10
|
+
|
|
11
|
+
When adding J Random Contributor's name to this file, either J's name on its
|
|
12
|
+
own or J's name associated with J's organization's name should be added,
|
|
13
|
+
depending on whether J's employer (or academic institution) has ownership
|
|
14
|
+
over code that is written for this project.
|
|
15
|
+
|
|
16
|
+
How to add names to this file:
|
|
17
|
+
|
|
18
|
+
```text
|
|
19
|
+
* Individual's name <submission email address>.
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
If Individual's organization is copyright holder of her contributions add the
|
|
23
|
+
organization's name, optionally also the contributor's name:
|
|
24
|
+
|
|
25
|
+
```text
|
|
26
|
+
* Organization's name
|
|
27
|
+
* Individual's name - <submission corporate email address>
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Please keep the list sorted.
|
|
31
|
+
|
|
32
|
+
## Contributors List
|
|
33
|
+
|
|
34
|
+
* Robert Bosch GmbH
|
|
35
|
+
* Nirmal Sasidharan - <nirmal.sasidharan@de.bosch.com>
|
|
36
|
+
* Wolfgang Ulmer - <wolfgang.ulmer@de.bosch.com>
|
|
37
|
+
* Aniket Salve - <aniketdilip.salve@bosch.com>
|
|
38
|
+
* :em engineering methods AG
|
|
39
|
+
* Celina Adelhardt - <celina.adelhardt@em.ag>
|
|
40
|
+
* Markus Braun - <markus.braun@em.ag>
|
|
41
|
+
* itemis AG
|
|
42
|
+
* Stefan Schulz - <stefan.schulz@itemis.com>
|
|
43
|
+
* Stream HPC B.V.
|
|
44
|
+
* Gergely Meszaros <gergely@streamhpc.com>
|
|
45
|
+
* Klarälvdalens Datakonsult AB (KDAB)
|
|
46
|
+
* Jonatan Wallmander <jonatan.wallmander@kdab.com>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: doxysphinx
|
|
3
|
-
Version: 3.3.
|
|
3
|
+
Version: 3.3.8
|
|
4
4
|
Summary: Integrates doxygen html documentation with sphinx.
|
|
5
5
|
Home-page: https://github.com/boschglobal/doxysphinx
|
|
6
6
|
License: MIT
|
|
@@ -9,14 +9,14 @@ Author: Nirmal Sasidharan
|
|
|
9
9
|
Author-email: nirmal.sasidharan@de.bosch.com
|
|
10
10
|
Maintainer: Nirmal Sasidharan
|
|
11
11
|
Maintainer-email: nirmal.sasidharan@de.bosch.com
|
|
12
|
-
Requires-Python: >=3.
|
|
12
|
+
Requires-Python: >=3.9,<3.13
|
|
13
13
|
Classifier: Framework :: Sphinx :: Extension
|
|
14
14
|
Classifier: License :: OSI Approved :: MIT License
|
|
15
15
|
Classifier: Programming Language :: Python :: 3
|
|
16
|
-
Classifier: Programming Language :: Python :: 3.8
|
|
17
16
|
Classifier: Programming Language :: Python :: 3.9
|
|
18
17
|
Classifier: Programming Language :: Python :: 3.10
|
|
19
18
|
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
20
20
|
Classifier: Topic :: Documentation
|
|
21
21
|
Classifier: Topic :: Documentation :: Sphinx
|
|
22
22
|
Classifier: Topic :: Software Development :: Build Tools
|
|
@@ -30,6 +30,7 @@ Requires-Dist: colorama (>=0.4.6,<0.5.0) ; sys_platform == "windows"
|
|
|
30
30
|
Requires-Dist: libsass (>=0.22.0,<0.23.0)
|
|
31
31
|
Requires-Dist: lxml (>=4.9.2,<5.0.0)
|
|
32
32
|
Requires-Dist: mpire (>=2.6.0,<3.0.0)
|
|
33
|
+
Requires-Dist: numpy (>=1.26.4,<2.0.0)
|
|
33
34
|
Requires-Dist: pyjson5 (>=1.6.2,<2.0.0)
|
|
34
35
|
Requires-Dist: pyparsing (>=3.0.9,<4.0.0)
|
|
35
36
|
Project-URL: Documentation, https://boschglobal.github.io/doxysphinx/
|
|
@@ -15,7 +15,7 @@ import re
|
|
|
15
15
|
import shutil
|
|
16
16
|
from dataclasses import dataclass
|
|
17
17
|
from pathlib import Path
|
|
18
|
-
from typing import Any, Dict, List, Union
|
|
18
|
+
from typing import Any, Dict, List, Tuple, Union, cast
|
|
19
19
|
|
|
20
20
|
import pyjson5
|
|
21
21
|
|
|
@@ -98,7 +98,7 @@ def _parse_stdout(text: str) -> ConfigDict:
|
|
|
98
98
|
pure_text = os.linesep.join([line for line in lines if _is_config_line(line)])
|
|
99
99
|
|
|
100
100
|
ParserElement.set_default_whitespace_chars(" \t")
|
|
101
|
-
line_end =
|
|
101
|
+
line_end = White("\r\n") | LineEnd()
|
|
102
102
|
|
|
103
103
|
doxy_flag = Word(srange("[A-Z_]")) + FollowedBy("=")
|
|
104
104
|
list_items = delimited_list(
|
|
@@ -162,6 +162,18 @@ class DoxygenSettingsValidator:
|
|
|
162
162
|
}
|
|
163
163
|
"""A dictionary containing further optional settings for the doxygen config."""
|
|
164
164
|
|
|
165
|
+
@staticmethod
|
|
166
|
+
def _normalize_option(key: str, value: Union[str, List[str]]) -> Union[str, List[str]]:
|
|
167
|
+
"""Normalize incoming value before comparing to recommended/mandatory setting."""
|
|
168
|
+
if key in ("OUTPUT_DIRECTORY", "GENERATE_TAGFILE"):
|
|
169
|
+
return Path(cast(str, value)).as_posix()
|
|
170
|
+
|
|
171
|
+
return value
|
|
172
|
+
|
|
173
|
+
@classmethod
|
|
174
|
+
def _normalize_item(cls, kv: Tuple[str, Union[str, List[str]]]) -> Tuple[str, Union[str, List[str]]]:
|
|
175
|
+
return (kv[0], cls._normalize_option(kv[0], kv[1]))
|
|
176
|
+
|
|
165
177
|
validation_errors: List[str] = []
|
|
166
178
|
"""List of the validation errors including the doxyflag with its used and the correct value."""
|
|
167
179
|
absolute_out: Path
|
|
@@ -205,10 +217,10 @@ class DoxygenSettingsValidator:
|
|
|
205
217
|
self.absolute_out = path_resolve(out)
|
|
206
218
|
stringified_out = str(out) if out.is_absolute() else f'"{out}" (resolved to "{self.absolute_out}")'
|
|
207
219
|
|
|
208
|
-
self.mandatory_settings["OUTPUT_DIRECTORY"] = str
|
|
220
|
+
self.mandatory_settings["OUTPUT_DIRECTORY"] = Path(cast(str, config["OUTPUT_DIRECTORY"])).as_posix()
|
|
209
221
|
|
|
210
222
|
if path_is_relative_to(out, sphinx_source_dir):
|
|
211
|
-
self.optional_settings["GENERATE_TAGFILE"] =
|
|
223
|
+
self.optional_settings["GENERATE_TAGFILE"] = out.joinpath("tagfile.xml").relative_to(doxygen_cwd).as_posix()
|
|
212
224
|
return True
|
|
213
225
|
else:
|
|
214
226
|
self.optional_settings["GENERATE_TAGFILE"] = "docs/doxygen/demo/html/tagfile.xml" # default value
|
|
@@ -222,7 +234,7 @@ class DoxygenSettingsValidator:
|
|
|
222
234
|
imported_settings = settings
|
|
223
235
|
target_settings = self.mandatory_settings
|
|
224
236
|
validation_successful = True
|
|
225
|
-
if all(item in imported_settings.items() for item in target_settings.items()):
|
|
237
|
+
if all(self._normalize_item(item) in imported_settings.items() for item in target_settings.items()):
|
|
226
238
|
return validation_successful
|
|
227
239
|
|
|
228
240
|
contained_settings_target = {
|
|
@@ -238,7 +250,8 @@ class DoxygenSettingsValidator:
|
|
|
238
250
|
validation_successful = False
|
|
239
251
|
|
|
240
252
|
for key in contained_settings_target.keys():
|
|
241
|
-
|
|
253
|
+
contained_setting = self._normalize_option(key, contained_settings_target[key])
|
|
254
|
+
if not contained_setting == target_settings[key]:
|
|
242
255
|
self.validation_errors.append(
|
|
243
256
|
(
|
|
244
257
|
f"Error: Wrong value {contained_settings_target[key]} for {key}, {target_settings[key]} is required."
|
|
@@ -252,7 +265,7 @@ class DoxygenSettingsValidator:
|
|
|
252
265
|
imported_settings = settings
|
|
253
266
|
target_settings = self.optional_settings
|
|
254
267
|
validation_successful = True
|
|
255
|
-
if all(item in imported_settings.items() for item in target_settings.items()):
|
|
268
|
+
if all(self._normalize_item(item) in imported_settings.items() for item in target_settings.items()):
|
|
256
269
|
return validation_successful
|
|
257
270
|
|
|
258
271
|
contained_settings_target = {
|
|
@@ -268,7 +281,8 @@ class DoxygenSettingsValidator:
|
|
|
268
281
|
validation_successful = False
|
|
269
282
|
|
|
270
283
|
for key in contained_settings_target.keys():
|
|
271
|
-
|
|
284
|
+
contained_setting = self._normalize_option(key, contained_settings_target[key])
|
|
285
|
+
if not contained_setting == target_settings[key]:
|
|
272
286
|
self.validation_errors.append(
|
|
273
287
|
(
|
|
274
288
|
f"Hint: Wrong value {contained_settings_target[key]} for {key}, {target_settings[key]} is recommended."
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
|
|
10
10
|
[tool.poetry]
|
|
11
11
|
name = "doxysphinx"
|
|
12
|
-
version = "3.3.
|
|
12
|
+
version = "3.3.8"
|
|
13
13
|
description = "Integrates doxygen html documentation with sphinx."
|
|
14
14
|
authors = [
|
|
15
15
|
"Nirmal Sasidharan <nirmal.sasidharan@de.bosch.com>",
|
|
@@ -36,7 +36,7 @@ classifiers = [
|
|
|
36
36
|
packages = [{ include = "doxysphinx" }]
|
|
37
37
|
|
|
38
38
|
[tool.poetry.dependencies]
|
|
39
|
-
python = ">=3.
|
|
39
|
+
python = ">=3.9,<3.13"
|
|
40
40
|
lxml = "^4.9.2"
|
|
41
41
|
colorama = { version = "^0.4.6", platform = "windows" }
|
|
42
42
|
click = "^8.1.3"
|
|
@@ -45,6 +45,7 @@ pyparsing = "^3.0.9"
|
|
|
45
45
|
mpire = "^2.6.0"
|
|
46
46
|
pyjson5 = "^1.6.2"
|
|
47
47
|
libsass = "^0.22.0"
|
|
48
|
+
numpy = "^1.26.4" # Adding this version of numpy to support python 3.12
|
|
48
49
|
|
|
49
50
|
[tool.poetry.group.sphinx.dependencies]
|
|
50
51
|
sphinx = "<7"
|
|
@@ -84,7 +85,7 @@ doxysphinx = "doxysphinx.cli:cli"
|
|
|
84
85
|
|
|
85
86
|
[tool.commitizen]
|
|
86
87
|
name = "cz_conventional_commits"
|
|
87
|
-
version = "3.3.
|
|
88
|
+
version = "3.3.8"
|
|
88
89
|
tag_format = "v$version"
|
|
89
90
|
version_files = ["pyproject.toml:^version"]
|
|
90
91
|
bump_message = """chore(release): release $current_version → $new_version by commitizen [skip-ci]
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|