{"id":14963186,"url":"https://github.com/espressif/doxybook","last_synced_at":"2025-09-30T16:31:51.519Z","repository":{"id":62139443,"uuid":"555232584","full_name":"espressif/doxybook","owner":"espressif","description":"Generate single-file API reference in Markdown for C/C++","archived":false,"fork":true,"pushed_at":"2024-10-25T09:08:59.000Z","size":1031,"stargazers_count":4,"open_issues_count":4,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-15T05:27:45.256Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"matusnovak/doxybook","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/espressif.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-10-21T07:22:51.000Z","updated_at":"2024-10-25T09:08:24.000Z","dependencies_parsed_at":"2023-02-11T00:45:33.755Z","dependency_job_id":"cc44ced6-7b59-4603-ab90-a7374c62887e","html_url":"https://github.com/espressif/doxybook","commit_stats":null,"previous_names":["espressif/doxybook"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/espressif%2Fdoxybook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/espressif%2Fdoxybook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/espressif%2Fdoxybook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/espressif%2Fdoxybook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/espressif","download_url":"https://codeload.github.com/espressif/doxybook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234753660,"owners_count":18881434,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T13:31:08.634Z","updated_at":"2025-09-30T16:31:46.263Z","avatar_url":"https://github.com/espressif.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# esp-doxybook\n\nThis is a tool that converts Doxygen XML output into a single-file API reference in Markdown format.\n\n## Live Demo\n\n- C Project: https://espressif.github.io/doxybook/c_api/\n- C++ Project: https://espressif.github.io/doxybook/cpp_api/\n\n## Requirements\n\nYou need to have **python 3.7 or newer** and [Jinja2](http://jinja.pocoo.org/docs/2.10/intro/) package installed.\n\n## Memory usage\n\nNeeds 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.\n\n## Installation\n\n**Install using Python Pip: \u003chttps://pypi.org/project/esp-doxybook/\u003e**\n\n## Use with [pre-commit](https://pre-commit.com/)\n\n```yaml\n- repo: https://github.com/espressif/doxybook\n  rev: v0.2.2\n  hooks:\n    - id: doxygen-api-md\n```\n\nThe default path of the generated xml files is `xml`, make sure it's matching the path in your Doxyfile.\n\nFor example, if you have this in your Doxyfile:\n\n```\nOUTPUT_DIRECTORY       = ./doxygen_output\n```\n\nThen you need to set the path in the pre-commit config like this:\n\n```yaml\n- repo: https://github.com/espressif/doxybook\n  rev: v0.2.2\n  hooks:\n    - id: doxygen-api-md\n      args: [\"-i\", \"doxygen_output/xml\", \"-o\", \"docs/api.md\"]\n```\n\nMake sure you've installed `doxygen` before you run `pre-commit install`. Otherwise, the hook will fail.\n\n## Compile the example\n\n```bash\ngit clone https://github.com/espressif/doxybook.git\n\ncd doxybook\n\n# Install dependencies\npython -m venv venv\nsource venv/bin/activate\npip install flit\nflit install -s\n\n# Let's take C project as an example\ncd example/c\nesp-doxybook -i temp/xml -o ../../docs/c_api.md\n\n# Preview Markdown with MkDocs\ncd ../../\nmkdocs serve\n```\n\nThen go to `http://localhost:8000/c_api/` to see the generated documentation.\n\n## Found a bug or want to request a feature?\n\n[Feel free to do it on GitHub issues](https://github.com/espressif/doxybook/issues)\n\n## Pull requests\n\n[Pull requests are welcome](https://github.com/espressif/doxybook/pulls)\n\n## License\n\n```\nMIT License\n\nCopyright (c) 2019 Matus Novak\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\nAdditions Copyright (c) 2022 Espressif Systems (Shanghai) Co. Ltd.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fespressif%2Fdoxybook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fespressif%2Fdoxybook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fespressif%2Fdoxybook/lists"}