GitHub - chinmaygarde/doxygen2docset: From Doxygen documentation, create a Docset for use in Dash or Zeal. (original) (raw)

Converts Doxygen Documentation to a Dash orZeal Docset.

Usage

1. Install the command line tool using one of the supported installation methods.
2. Prepare your Doxygen docs.
3. Generate the Docset from the Doxygen generated docs using:

doxgen2docset --doxygen <path to doxygen source> --docset <path to docset dir> [--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.
• 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

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.

Installation

Package Managers

Homebrew

On Linux and macOS, using the Homebrew package manager.

brew tap chinmaygarde/tap brew install doxygen2docset

GitHub Releases

Grab a prebuilt binary for a recent release.

Build from Source

Build the binary yourself using these instructions.

Build Prerequisites

• CMake (3.10 or above).
• Git.
• Ninja.
• Just, a task runner.
• A C++14 compiler.
• vcpkg for package management.
  • Ensure that the VCPKG_ROOT environment variable is present and valid.

Build Instructions

• Generate the build directory.
• Build the artifacts.
• The executable is present in ./build/source/doxygen2docset.
• The unit-test target is present in ./build/tests/doxygen2docset_unittests.

Release Workflow

Tag a commit with a name of the format vx.x.x. GitHub CI should take care of the rest.