https://github.com/raspberrypi/doxygentoasciidoc
A Doxygen to AsciiDoc converter
https://github.com/raspberrypi/doxygentoasciidoc
Last synced: about 2 months ago
JSON representation
A Doxygen to AsciiDoc converter
- Host: GitHub
- URL: https://github.com/raspberrypi/doxygentoasciidoc
- Owner: raspberrypi
- License: bsd-3-clause
- Created: 2024-08-06T09:16:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-25T08:30:02.000Z (about 1 year ago)
- Last Synced: 2025-01-29T21:43:35.335Z (11 months ago)
- Language: Python
- Homepage:
- Size: 75.2 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# doxygentoasciidoc: A Doxygen to AsciiDoc Converter
```
usage: doxygentoasciidoc [-h] [-o OUTPUT] [-c] file
Convert Doxygen XML to AsciiDoc
positional arguments:
file The path of the Doxygen XML file to convert
optional arguments:
-h, --help show this help message and exit
-o OUTPUT, --output OUTPUT
Write to file instead of stdout
-c, --child Is NOT the root index file
```
## Development
Install the development dependencies:
```console
$ pip install -r dev.txt
```
Run the test suite:
```console
$ pytest
```
Ensure code is formatted consistently:
```console
$ black --check .
```
Ensure code passes linting:
```console
$ pylint doxygentoasciidoc
```