Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/espressif/doxybook

Generate single-file API reference in Markdown for C/C++
https://github.com/espressif/doxybook

Last synced: 2 days ago
JSON representation

Generate single-file API reference in Markdown for C/C++

Host: GitHub
URL: https://github.com/espressif/doxybook
Owner: espressif
License: other
Fork: true (matusnovak/doxybook)
Created: 2022-10-21T07:22:51.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2023-10-17T11:36:07.000Z (12 months ago)
Last Synced: 2024-09-18T16:00:25.883Z (8 days ago)
Language: Python
Homepage:
Size: 1.22 MB
Stars: 4
Watchers: 3
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# esp-doxybook

This is a tool that converts Doxygen XML output into a single-file API reference in Markdown format.

## Live Demo

- C Project: https://espressif.github.io/doxybook/c_api/
- C++ Project: https://espressif.github.io/doxybook/cpp_api/

## Requirements

You need to have **python 3.7 or newer** and [Jinja2](http://jinja.pocoo.org/docs/2.10/intro/) package installed.

## Memory usage

Needs up to 100MiB of memory. Parsing super large projects can use up to 0.5GiB of memory. For example, a project consisting of 1000 Doxygen xml files can use 550MiB of memory, but I would be worried more about VuePress or GitBook memory usage while using that many files.

## Installation

**Install using Python Pip: **

## Use with [pre-commit](https://pre-commit.com/)

```yaml
- repo: https://github.com/espressif/doxybook
rev: v0.2.1
hooks:
- id: doxygen-api-md
```

The default path of the generated xml files is `xml`, make sure it's matching the path in your Doxyfile.

For example, if you have this in your Doxyfile:

```
OUTPUT_DIRECTORY = ./doxygen_output
```

Then you need to set the path in the pre-commit config like this:

```yaml
- repo: https://github.com/espressif/doxybook
rev: v0.2.1
hooks:
- id: doxygen-api-md
args: ["-i", "doxygen_output/xml", "-o", "docs/api.md"]
```

Make sure you've installed `doxygen` before you run `pre-commit install`. Otherwise, the hook will fail.

## Compile the example

```bash
git clone https://github.com/espressif/doxybook.git

cd doxybook

# Install dependencies
python -m venv venv
source venv/bin/activate
pip install flit
flit install -s

# Let's take C project as an example
cd example/c
esp-doxybook -i temp/xml -o ../../docs/c_api.md

# Preview Markdown with MkDocs
cd ../../
mkdocs serve
```

Then go to `http://localhost:8000/c_api/` to see the generated documentation.

## Found a bug or want to request a feature?

[Feel free to do it on GitHub issues](https://github.com/espressif/doxybook/issues)

## Pull requests

[Pull requests are welcome](https://github.com/espressif/doxybook/pulls)

## License

```
MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.