{"id":21672087,"url":"https://github.com/jcarrano/antidox","last_synced_at":"2026-04-28T23:36:57.392Z","repository":{"id":57410641,"uuid":"138768218","full_name":"jcarrano/antidox","owner":"jcarrano","description":"Sphinx autodoc \u0026 autoindex using Doxygen","archived":false,"fork":false,"pushed_at":"2021-01-04T14:52:57.000Z","size":231,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-09-06T10:35:57.298Z","etag":null,"topics":["api-documentation","autodoc","c","documentation","doxygen","python","sphinx","sphinx-extension","xslt"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jcarrano.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-26T17:03:34.000Z","updated_at":"2023-04-06T10:52:41.000Z","dependencies_parsed_at":"2022-08-28T01:14:07.249Z","dependency_job_id":null,"html_url":"https://github.com/jcarrano/antidox","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/jcarrano/antidox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcarrano%2Fantidox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcarrano%2Fantidox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcarrano%2Fantidox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcarrano%2Fantidox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jcarrano","download_url":"https://codeload.github.com/jcarrano/antidox/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcarrano%2Fantidox/sbom","scorecard":{"id":511039,"data":{"date":"2025-08-11","repo":{"name":"github.com/jcarrano/antidox","commit":"e01e9b45b34db8be46a92663cf31e60a70f553f1"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.1,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: BSD 3-Clause \"New\" or \"Revised\" License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: Dockerfile:1","Warn: containerImage not pinned by hash: Dockerfile:6: pin your Docker image by updating jcarrano/sphinx-doc to jcarrano/sphinx-doc@sha256:03e9eba7b6395a37c18ba2c048fcd5c028fb17d3097b38b6c03ecccb01e42ceb","Warn: pipCommand not pinned by hash: build.sh:214","Warn: pipCommand not pinned by hash: build.sh:219","Info:   0 out of   2 containerImage dependencies pinned","Info:   0 out of   2 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Vulnerabilities","score":4,"reason":"6 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-55x5-fj6c-h6m8","Warn: Project is vulnerable to: PYSEC-2014-9 / GHSA-57qw-cc2g-pv5p","Warn: Project is vulnerable to: PYSEC-2021-19 / GHSA-jq4v-f5q6-mjqq","Warn: Project is vulnerable to: GHSA-pgww-xf46-h92r","Warn: Project is vulnerable to: PYSEC-2022-230 / GHSA-wrxv-2j5q-m38w","Warn: Project is vulnerable to: PYSEC-2018-12 / GHSA-xp26-p53h-6h2p"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-20T00:33:19.479Z","repository_id":57410641,"created_at":"2025-08-20T00:33:19.479Z","updated_at":"2025-08-20T00:33:19.479Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273892835,"owners_count":25186561,"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","status":"online","status_checked_at":"2025-09-06T02:00:13.247Z","response_time":2576,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["api-documentation","autodoc","c","documentation","doxygen","python","sphinx","sphinx-extension","xslt"],"created_at":"2024-11-25T13:17:11.497Z","updated_at":"2026-04-28T23:36:52.358Z","avatar_url":"https://github.com/jcarrano.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"==============================================\nAntidox: Use Doxygen sanely from within Sphinx\n==============================================\n\n---------------------------\nAn antidote to doxy-madness\n---------------------------\n\n|docs| |pypi|\n\n\nSummary\n=======\n\n``antidox`` is a Sphinx_ extension that can read Doxygen_ XML \"databases\" and\ninsert documentation for entities in Sphinx documents, similar to Breathe_.\n\nIt is intended to be *fast* and simple, though *easily customizable*.\n\nDocument generation (i.e. conversion between doxy-xml and reStructuredText) is\ndriven by XML stylesheets (powered by lxml_,) while indexing and selection of\ndocumentable entities is done by a SQL database (sqlite3_.)\n\nHere is an `example project \u003ccbor_example_\u003e`_ showing showing this extension in\naction.\n\nExample usage\n=============\n\nGenerate the documentation for an entire header, and include all entities defined\nin that header::\n\n  .. doxy:c:: lua_run.h::*\n      :children:\n      \nThe syntax *\u003cpath\u003e*::*\u003cidentifier\u003e* can be used to disambiguate between entities\nwith the same name in different files.\n\nTo document a Doxygen group::\n\n  .. doxy:c:: [CborPretty]\n      :children:\n\nYou can manually specify which children should be documented::\n\n  .. doxy:c:: be_uint16_t\n      :children: u16\n\nCross references are provided by a custom role, e.g.::\n\n  :doxy:r:`be_uint16_t::u16`\n\nThe complete syntax is decribed in the docs_.\n\nStub generation\n---------------\n\nThe gen_stubs.py_ script shows how stub files can be automatically generated.\nYou can adapt this script to your own project.\n\nGenerating API docs this way is fast and convenient, but may be suboptimal,\nsince the spirit of this extension (and of Sphinx) is to generate narrative\ndocumentation and not merely an API reference.\n\nNote: Beta\n==========\n\nThough usable, this extension is still under development. Backwards\ncompatibility will be kept for all releases with the same major/minor version.\n\nBe aware, however, that after updating this extension you may need to do a clean\nbuild of your docs to see the results.\n\nObjectives\n==========\n\n* Reuse API docs made with Doxygen in a Sphinx project.\n* Provide a smooth transition between 100% automatic API docs (what Doxygen\n  generates) and semi-manual documentation (autodoc-style).\n* Have sensible defaults for automatic documentation generation while allowing\n  customization.\n* Deal with big projects efficiently: the main tool in use now (Breathe)\n  has resource usage issues when dealing with large XML files.\n\n.. |docs| image:: https://readthedocs.org/projects/antidox/badge/?version=latest\u0026style=for-the-badge\n    :alt: Documentation Status\n    :scale: 100%\n    :target: https://antidox.readthedocs.io/en/latest/?badge=latest\n\n.. |pypi| image:: https://img.shields.io/pypi/v/antidox.svg?style=for-the-badge\n    :alt: PyPI\n    :scale: 200%\n    :target: https://pypi.org/project/antidox/\n\n.. _Sphinx: https://www.sphinx-doc.org\n.. _Doxygen: http://www.doxygen.nl/\n.. _Breathe: https://breathe.readthedocs.io/en/latest/\n.. _lxml: https://lxml.de/\n.. _sqlite3: https://docs.python.org/3/library/sqlite3.html\n.. _cbor_example: https://antidox-example.readthedocs.io/en/latest/\n.. _docs: https://antidox.readthedocs.io/en/latest/guide.html#directives-roles-and-domains\n.. _gen_stubs.py: examples/riot/gen_stubs.py\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcarrano%2Fantidox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjcarrano%2Fantidox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcarrano%2Fantidox/lists"}