https://github.com/chinmaygarde/doxygen2docset
From Doxygen documentation, create a Docset for use in Dash or Zeal.
https://github.com/chinmaygarde/doxygen2docset
Last synced: 2 months ago
JSON representation
From Doxygen documentation, create a Docset for use in Dash or Zeal.
- Host: GitHub
- URL: https://github.com/chinmaygarde/doxygen2docset
- Owner: chinmaygarde
- License: mit
- Created: 2019-08-29T00:17:13.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-19T18:50:07.000Z (3 months ago)
- Last Synced: 2025-04-22T10:37:33.737Z (2 months ago)
- Language: C++
- Size: 3.25 MB
- Stars: 19
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Dash or Zeal Docsets from Doxygen Documentation
===============================================
Converts Doxygen Documentation to a [Dash](https://kapeli.com/dash) or
[Zeal](https://zealdocs.org/) Docset.
Usage
-----
* [Prepare your Doxygen docs](#preparing-project-doxyfile-for-docsets).
* Generate the Docset from the Doxygen generated docs using:
```
doxgen2docset --doxygen --docset [--help]
```
Preparing Project Doxyfile for Docsets
--------------------------------------
* In the `Doxyfile` for your project, make sure the following options are set:
* `GENERATE_DOCSET = YES`
* `GENERATE_HTML = YES`
* For more thorough instructions on configuring Doxygen. [See this reference](https://kapeli.com/docsets#doxygen).
* Invoke `doxygen` to generate HTML documentation. On a successful invocation
of doxygen with the required flags, the html/ directory should be generated.
* This tool depends on reading the following files generated by Doxygen. If
these files are absent, the docset cannot be generated.
* `Tokens.xml`
* `Info.plist`
Building
--------
Requirements: A C++ 14 compiler and CMake.
* Make sure to pull submodules.
```sh
git submodule update --init --recursive
```
* Configure the build system.
```sh
cmake -B build
```
* Build the executable and tests.
```sh
cmake --build build
```
* The executable is present in `./build/source/doxygen2docset`.
* The unit-test target is present in `./build/tests/doxygen2docset_unittests`.
Options
-------
```
--doxygen Required: The path the HTML sources generated by Doxygen,
see the explanatory section below on how to configure Doxygen.
--docset Required: The path to the directory where this tool will
generate the docset. The name of the docset will be derived
from the Docset bundle identifier. For example, if the
Docset bundle identifer is, "com.exmple.docs", a docset
named "com.exmple.docs.docset" will be generated in this
directory.
To configure the docset bundle identifier, set the
DOCSET_BUNDLE_ID property in your Doxyfile before generating
documentation.
--help Print this documentation.
```