Python script to convert Doxygen XML into static HTML webpages for C++ documentation.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
Doxyfile
LICENSE
README.md
critical.css
footer.html
gulpfile.js
hamburger.svg
header.html
make_docs.py
paths.js
script.js
style.css

README.md

make_docs.py is a script that converts XML output from Doxygen into static HTML webpages. As an example, the C++ documentation webpages for my projects were generated using this script. I modeled the theme after Google's Protocol Buffer API reference.

For convenience, I also added a gulpfile.js to streamline the process and further compile/compress the output HTML.

Usage

  1. Make sure you have Doxygen and Python 3 installed.
  2. Place your library/repository folders into a single folder (the default directory is "..", i.e. the parent directory).
  3. Edit the Doxygen configuration file as appropriate for your project (specifically, list the paths to each of your libraries/repositories in the INPUT option, and make sure GENERATE_HTML is disabled).
  4. Edit the configuration variables at the top of make_docs.py as appropriate for your project. Make sure to change src_root to the folder containing your libraries/repositories.
  5. Modify the header.html, footer.html, CSS, and Javascript files to your liking.
  6. Run doxygen Doxyfile to generate the XML in Docs/xml/.
  7. Run make_docs.py to generate the HTML in Docs/html/.

If you have gulp installed, simply run gulp in place of steps 6 and 7 above.