{"id":16360362,"url":"https://github.com/mike42/doxyphp2sphinx","last_synced_at":"2025-10-26T04:32:11.291Z","repository":{"id":46281086,"uuid":"133864127","full_name":"mike42/doxyphp2sphinx","owner":"mike42","description":"API Documentation generator for PHP priojects which use Sphinx.","archived":false,"fork":false,"pushed_at":"2021-02-11T02:51:40.000Z","size":15,"stargazers_count":2,"open_issues_count":3,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-25T12:46:11.523Z","etag":null,"topics":["documentation","doxygen","php","readthedocs","restructuredtext","sphinx"],"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-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mike42.png","metadata":{"files":{"readme":"README.md","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-05-17T20:18:23.000Z","updated_at":"2018-11-07T09:46:51.000Z","dependencies_parsed_at":"2022-09-26T21:20:54.282Z","dependency_job_id":null,"html_url":"https://github.com/mike42/doxyphp2sphinx","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mike42/doxyphp2sphinx","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mike42%2Fdoxyphp2sphinx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mike42%2Fdoxyphp2sphinx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mike42%2Fdoxyphp2sphinx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mike42%2Fdoxyphp2sphinx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mike42","download_url":"https://codeload.github.com/mike42/doxyphp2sphinx/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mike42%2Fdoxyphp2sphinx/sbom","scorecard":{"id":645119,"data":{"date":"2025-08-11","repo":{"name":"github.com/mike42/doxyphp2sphinx","commit":"94eacd4d84a9318b73674de8756dde784064cec0"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/5 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":"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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"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":"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":"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":"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":"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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: BSD 2-Clause \"Simplified\" 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":"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"}}]},"last_synced_at":"2025-08-21T11:57:18.773Z","repository_id":46281086,"created_at":"2025-08-21T11:57:18.774Z","updated_at":"2025-08-21T11:57:18.774Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281059645,"owners_count":26437056,"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-10-26T02:00:06.575Z","response_time":61,"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":["documentation","doxygen","php","readthedocs","restructuredtext","sphinx"],"created_at":"2024-10-11T02:11:16.650Z","updated_at":"2025-10-26T04:32:10.917Z","avatar_url":"https://github.com/mike42.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# doxyphp2sphinx\n\nAPI Documentation generator for PHP projects which use Sphinx.\n\nIt acts as a compatibility layer between Doxygen (which is good at reading PHP),\nand Sphinx (which is used by some online services to host HTML docs).\n\n- http://www.sphinx-doc.org/en/master/\n- http://www.doxygen.org/\n\nThis tool is compatible with Python 2 and 3.\n\n## Installation\n\n### From source\n\n```bash\ngit clone https://github.com/mike42/\npython setup.py bdist_wheel --universal\npip install dist/doxyphp2sphinx-*.whl\n```\n\n### From pip\n\n```bash\npip install doxyphp2sphinx\n```\n\n### Verification\n\nTest that you have the command.\n\n```\ndoxyphp2sphinx --help\n```\n\n## Command-line use\n\nThis package provides the `doxyphp2sphinx` command, which generates `.rst` files as output, given a directory\nof `doxygen` XML files.\n\n```bash\nusage: doxyphp2sphinx [-h] [--xml-dir XML_DIR] [--out-dir OUT_DIR] [--verbose]\n                      [--quiet]\n                      root_namespace\n\nGenerate Sphinx-ready reStructuredText documentation or your PHP project,\nusing Doxygen XML as an input.\n\npositional arguments:\n  root_namespace\n\noptional arguments:\n  -h, --help         show this help message and exit\n  --xml-dir XML_DIR  directory to read from\n  --out-dir OUT_DIR  directory to write to\n  --verbose, -v      more output\n  --quiet, -q        less output\n```\n\n## Example\n\nThe `gfx-php` project uses this tool to publish documentation to [readthedocs.org](https://readthedocs.org/), so\nwe'll use that as an example:\n\n- Code: https://github.com/mike42/gfx-php\n- Docs: https://gfx-php.readthedocs.io\n\n```\ngit clone https://github.com/mike42/gfx-php\ncd docs\ndoxygen\ndoxyphp2sphinx Mike42::GfxPhp\nmake html\n```\n\n## License\n\ndoxyphp2sphinx is released under a BSD 2-Clause License. See LICENSE for the full text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmike42%2Fdoxyphp2sphinx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmike42%2Fdoxyphp2sphinx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmike42%2Fdoxyphp2sphinx/lists"}