{"id":13760147,"url":"https://github.com/chinmaygarde/doxygen2docset","last_synced_at":"2025-04-22T10:37:39.921Z","repository":{"id":136203076,"uuid":"205046213","full_name":"chinmaygarde/doxygen2docset","owner":"chinmaygarde","description":"From Doxygen documentation, create a Docset for use in Dash or Zeal.","archived":false,"fork":false,"pushed_at":"2025-04-19T18:50:07.000Z","size":3404,"stargazers_count":19,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-22T10:37:33.737Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chinmaygarde.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-08-29T00:17:13.000Z","updated_at":"2025-04-19T18:50:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"1617d33d-b73f-4928-8395-86adfef9df2c","html_url":"https://github.com/chinmaygarde/doxygen2docset","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chinmaygarde%2Fdoxygen2docset","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chinmaygarde%2Fdoxygen2docset/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chinmaygarde%2Fdoxygen2docset/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chinmaygarde%2Fdoxygen2docset/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chinmaygarde","download_url":"https://codeload.github.com/chinmaygarde/doxygen2docset/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250221946,"owners_count":21394791,"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-08-03T13:01:04.197Z","updated_at":"2025-04-22T10:37:39.869Z","avatar_url":"https://github.com/chinmaygarde.png","language":"C++","funding_links":[],"categories":["C++"],"sub_categories":[],"readme":"Dash or Zeal Docsets from Doxygen Documentation\n===============================================\n\nConverts Doxygen Documentation to a [Dash](https://kapeli.com/dash) or\n[Zeal](https://zealdocs.org/) Docset.\n\nUsage\n-----\n\n* [Prepare your Doxygen docs](#preparing-project-doxyfile-for-docsets).\n* Generate the Docset from the Doxygen generated docs using:\n  ```\n  doxgen2docset --doxygen \u003cpath to doxygen source\u003e --docset \u003cpath to docset dir\u003e [--help]\n  ```\n\nPreparing Project Doxyfile for Docsets\n--------------------------------------\n\n* In the `Doxyfile` for your project, make sure the following options are set:\n  * `GENERATE_DOCSET = YES`\n  * `GENERATE_HTML   = YES`\n  * For more thorough instructions on configuring Doxygen. [See this reference](https://kapeli.com/docsets#doxygen).\n* Invoke `doxygen` to generate HTML documentation. On a successful invocation\n  of doxygen with the required flags, the html/ directory should be generated.\n  * This tool depends on reading the following files generated by Doxygen. If\n    these files are absent, the docset cannot be generated.\n    * `Tokens.xml`\n    * `Info.plist`\n\nBuilding\n--------\n\nRequirements: A C++ 14 compiler and CMake.\n\n* Make sure to pull submodules.\n```sh\ngit submodule update --init --recursive\n```\n* Configure the build system.\n```sh\ncmake -B build\n```\n* Build the executable and tests.\n```sh\ncmake --build build\n```\n* The executable is present in `./build/source/doxygen2docset`.\n* The unit-test target is present in `./build/tests/doxygen2docset_unittests`.\n\nOptions\n-------\n\n```\n  --doxygen       Required: The path the HTML sources generated by Doxygen,\n                  see the explanatory section below on how to configure Doxygen.\n\n  --docset        Required: The path to the directory where this tool will\n                  generate the docset. The name of the docset will be derived\n                  from the Docset bundle identifier. For example, if the\n                  Docset bundle identifer is, \"com.exmple.docs\", a docset\n                  named \"com.exmple.docs.docset\" will be generated in this\n                  directory.\n\n                  To configure the docset bundle identifier, set the\n                  DOCSET_BUNDLE_ID property in your Doxyfile before generating\n                  documentation.\n\n  --help          Print this documentation.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchinmaygarde%2Fdoxygen2docset","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchinmaygarde%2Fdoxygen2docset","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchinmaygarde%2Fdoxygen2docset/lists"}