{"repo":"langroodi/doxygenize","free":true,"listed":false,"github":"https://github.com/langroodi/doxygenize","clone":"git clone https://github.com/langroodi/doxygenize.git","description":"Minimalist GitHub Action to automatically publish Doxygen-generated code documentation to GitHub Pages","language":"Shell","stars":17,"topics":["github-pages","github-actions","doxygen"],"license":"MIT","category":"workflow-automation","readme_excerpt":"doxygenize This is a GitHub Action to automatically generate Doxygen code documentation and publish it to GitHub Pages. The generator only supports HTML format, and currently it cannot handle LaTeX outputs. Setup - Generate a default Doxygen configuration file called Doxyfile (Special thanks to @MatiasLGonzalez for correcting me and also adding dot tool support); - Disable the following option in the Doxygen configuration file: - doxygen is called from the root directory of your repository, so any path on your Doxyfile should be relative to this directory and NOT relative to directory where your Doxyfile is located, i.e. if you have a project set up like: then your OUTPUT DIRECTORY , HTML OUTPUT and INPUT variables (and any other path variable) should be set like - Enable GitHub Pages branch (i.e., gh-pages) on your repository using this tutorial; - Copy the Doxygen configuration file to root of your repository; - Call action/checkoutv2 in the workflow to clone the repository; - Add following step to your respository workflow script: - In case of different: - Doxygen configuration file name and/or path; - HTML output folder; - GitHub Pages branch name; - GitHub Pages home directory which contains index.html file; - Using Doxygen Dark Mode (partially tested on Mozilla 96.0 (64-bit) for Ubuntu) please refer to the Inputs section. Inputs Name Type Default Description ---- ---- ------- ----------- doxygenconf string ./Doxyfile Doxygen configuration file path htmloutput string ./d","default_branch":null,"files":null,"tree":[],"storefront":"/r/langroodi","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/langroodi/doxygenize/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}