doxysphinx 3.2.0__tar.gz → 3.2.2__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.2.0 → doxysphinx-3.2.2}/PKG-INFO +1 -1
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/doxygen.py +12 -11
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/writer.py +1 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/pyproject.toml +2 -2
- doxysphinx-3.2.0/setup.py +0 -42
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/LICENSE +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/LICENSE.md +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/README.md +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/__init__.py +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/__main__.py +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/cli.py +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/html_parser.py +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/process.py +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/resources/custom.scss +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/resources/toc_template.html.j2 +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/resources.py +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/sphinx.py +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/toc.py +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/utils/__init__.py +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/utils/contexts.py +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/utils/exceptions.py +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/utils/files.py +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/utils/iterators.py +0 -0
- {doxysphinx-3.2.0 → doxysphinx-3.2.2}/doxysphinx/utils/pathlib_fix.py +0 -0
|
@@ -6,11 +6,13 @@
|
|
|
6
6
|
# Author(s):
|
|
7
7
|
# - Markus Braun, :em engineering methods AG (contracted by Robert Bosch GmbH)
|
|
8
8
|
# - Celina Adelhardt, :em engineering methods AG (contracted by Robert Bosch GmbH)
|
|
9
|
+
# - Gergely Meszaros, Stream HPC B.V. (contracted by Advanced Micro Devices Inc.)
|
|
9
10
|
# =====================================================================================
|
|
10
11
|
"""The doxygen module contains classes and functions specific to doxygen."""
|
|
11
12
|
|
|
12
13
|
import os
|
|
13
14
|
import re
|
|
15
|
+
import shutil
|
|
14
16
|
from dataclasses import dataclass
|
|
15
17
|
from pathlib import Path
|
|
16
18
|
from typing import Any, Dict, List, Union
|
|
@@ -50,18 +52,17 @@ def read_doxyconfig(doxyfile: Path, doxygen_exe: str, doxygen_cwd: Path) -> Conf
|
|
|
50
52
|
def _compare_configs(doxyfile: Path, doxygen_exe: str, doxygen_cwd: Path) -> DoxyOutput:
|
|
51
53
|
from subprocess import CalledProcessError, run # nosec: B404
|
|
52
54
|
|
|
55
|
+
doxygen = shutil.which(doxygen_exe)
|
|
56
|
+
if doxygen is None:
|
|
57
|
+
return DoxyOutput("", f"Command not found: {doxygen_exe}")
|
|
58
|
+
|
|
53
59
|
try:
|
|
54
|
-
default_config = run( # nosec:
|
|
55
|
-
|
|
56
|
-
)
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
cwd=doxygen_cwd,
|
|
61
|
-
shell=True, # nosec: B602
|
|
62
|
-
capture_output=True, # nosec: B607, B603
|
|
63
|
-
) # nosec: B607, B603
|
|
64
|
-
custom_config.check_returncode
|
|
60
|
+
default_config = run( # nosec: B603
|
|
61
|
+
[doxygen_exe, "-s", "-g", "-"], cwd=doxygen_cwd, capture_output=True, check=True
|
|
62
|
+
)
|
|
63
|
+
custom_config = run( # nosec: B603
|
|
64
|
+
[doxygen_exe, "-x", doxyfile.absolute()], cwd=doxygen_cwd, capture_output=True, check=False
|
|
65
|
+
)
|
|
65
66
|
|
|
66
67
|
return DoxyOutput(
|
|
67
68
|
default_config.stdout.decode("utf-8") + custom_config.stdout.decode("utf-8"),
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
|
|
10
10
|
[tool.poetry]
|
|
11
11
|
name = "doxysphinx"
|
|
12
|
-
version = "3.2.
|
|
12
|
+
version = "3.2.2"
|
|
13
13
|
description = "Integrates doxygen html documentation with sphinx."
|
|
14
14
|
authors = [
|
|
15
15
|
"Nirmal Sasidharan <nirmal.sasidharan@de.bosch.com>",
|
|
@@ -88,7 +88,7 @@ doxysphinx = "doxysphinx.cli:cli"
|
|
|
88
88
|
|
|
89
89
|
[tool.commitizen]
|
|
90
90
|
name = "cz_conventional_commits"
|
|
91
|
-
version = "3.2.
|
|
91
|
+
version = "3.2.2"
|
|
92
92
|
tag_format = "v$version"
|
|
93
93
|
version_files = ["pyproject.toml:^version"]
|
|
94
94
|
bump_message = """chore(release): release $current_version → $new_version by commitizen [skip-ci]
|
doxysphinx-3.2.0/setup.py
DELETED
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
# -*- coding: utf-8 -*-
|
|
2
|
-
from setuptools import setup
|
|
3
|
-
|
|
4
|
-
packages = \
|
|
5
|
-
['doxysphinx', 'doxysphinx.utils']
|
|
6
|
-
|
|
7
|
-
package_data = \
|
|
8
|
-
{'': ['*'], 'doxysphinx': ['resources/*']}
|
|
9
|
-
|
|
10
|
-
install_requires = \
|
|
11
|
-
['click-log>=0.4.0,<0.5.0',
|
|
12
|
-
'click>=8.1.3,<9.0.0',
|
|
13
|
-
'json5>=0.9.8,<0.10.0',
|
|
14
|
-
'lxml>=4.9.1,<5.0.0',
|
|
15
|
-
'pyparsing>=3.0.9,<4.0.0']
|
|
16
|
-
|
|
17
|
-
extras_require = \
|
|
18
|
-
{':sys_platform == "windows"': ['colorama>=0.4.5,<0.5.0']}
|
|
19
|
-
|
|
20
|
-
entry_points = \
|
|
21
|
-
{'console_scripts': ['doxysphinx = doxysphinx.cli:cli']}
|
|
22
|
-
|
|
23
|
-
setup_kwargs = {
|
|
24
|
-
'name': 'doxysphinx',
|
|
25
|
-
'version': '3.2.0',
|
|
26
|
-
'description': 'Integrates doxygen html documentation with sphinx.',
|
|
27
|
-
'long_description': '<!--\n=====================================================================================\n C O P Y R I G H T\n-------------------------------------------------------------------------------------\n Copyright (c) 2022 by Robert Bosch GmbH. All rights reserved.\n\n Author(s):\n - Markus Braun, :em engineering methods AG (contracted by Robert Bosch GmbH)\n - Nirmal Sasidharan, Robert Bosch Gmbh\n - Wolfgang Ulmer, Robert Bosch GmbH\n=====================================================================================\n-->\n\n<div align="center">\n\n<img src="https://raw.githubusercontent.com/boschglobal/doxysphinx/main/docs/resources/doxysphinx_logo.svg" alt="doxysphinx" width=500 />\n\n</div>\n\n---\n\n[](LICENSE.md)\n[](https://pypi.org/project/doxysphinx/)\n[](https://pypi.org/project/doxysphinx/)\n[](https://github.com/boschglobal/doxysphinx/actions/workflows/ci.yml)\n[](https://github.com/boschglobal/doxysphinx/actions/workflows/cd.yml)\n\nDoxysphinx is a [Doxygen](https://doxygen.nl) and [Sphinx](https://sphinx-doc.org) integration tool.\n\nIt is an easy-to-use cli tool and typically runs right after Doxygen generation.\nIt reuses the Doxygen generated HTML output and integrates it into Sphinx document generation.\nWith this, Doxysphinx supports all known Doxygen features and at the same time integrates well with the Sphinx output (for example, Sphinx-Themes, search etc.).\nDoxysphinx, also supports [restructured text (rST) annotations](https://github.com/boschglobal/doxysphinx/blob/main/docs/using_rst_in_doxygen.md) within C++ files.\n\nInternally, Doxysphinx creates an rST file for each (Doxygen) HTML file and includes the HTML using `.. raw:: html` directive.\nLater Sphinx picks up these rST files and creates an integrated documentation.\n\nCheck out Doxysphinx alternatives [here](https://github.com/boschglobal/doxysphinx/blob/main/docs/alternatives.md).\n\n## Links\n\n📚 [Doxysphinx Overview](https://boschglobal.github.io/doxysphinx)\n\n🚀 [Getting Started](https://boschglobal.github.io/doxysphinx/docs/getting_started.html)\n\n💻 [Developer Quickstart](https://boschglobal.github.io/doxysphinx/docs/dev_guide.html)\n\n🤖 [Releases](https://github.com/boschglobal/doxysphinx/releases)\n',
|
|
28
|
-
'author': 'Nirmal Sasidharan',
|
|
29
|
-
'author_email': 'nirmal.sasidharan@de.bosch.com',
|
|
30
|
-
'maintainer': 'Nirmal Sasidharan',
|
|
31
|
-
'maintainer_email': 'nirmal.sasidharan@de.bosch.com',
|
|
32
|
-
'url': 'https://github.com/boschglobal/doxysphinx',
|
|
33
|
-
'packages': packages,
|
|
34
|
-
'package_data': package_data,
|
|
35
|
-
'install_requires': install_requires,
|
|
36
|
-
'extras_require': extras_require,
|
|
37
|
-
'entry_points': entry_points,
|
|
38
|
-
'python_requires': '>=3.8,<3.11',
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
setup(**setup_kwargs)
|
|
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
|