Sign inSign up

manu343726/mdotcss-doxygen

By manu343726

•Updated over 7 years ago

m.css doxygen generator as an alpine docker container

Image
0

249

manu343726/mdotcss-doxygen repository overview

This image provides m.css⁠ doxygen generator as a standalone docker container. Run as follows:

docker run -w=$(pwd) -v$(pwd):$(pwd) manu343726/mdotcss-doxygen [m.css doxygen generator args]

I recommend wrapping the container call in a doxygen.sh script:

#!/bin/sh
docker run -w=$(pwd) -v$(pwd):$(pwd) manu343726/mdotcss-doxygen $@
./doxygen.sh --help
usage: doxygen.py [-h] [--templates TEMPLATES] [--wildcard WILDCARD]
                  [--index-pages INDEX_PAGES [INDEX_PAGES ...]] [--no-doxygen]
                  [--search-no-subtree-merging]
                  [--search-no-lookahead-barriers]
                  [--search-no-prefix-merging] [--sort-globbed-files]
                  [--debug]
                  doxyfile

positional arguments:
  doxyfile              where the Doxyfile is

optional arguments:
  -h, --help            show this help message and exit
  --templates TEMPLATES
                        template directory
  --wildcard WILDCARD   only process files matching the wildcard
  --index-pages INDEX_PAGES [INDEX_PAGES ...]
                        index page templates
  --no-doxygen          don't run Doxygen before
  --search-no-subtree-merging
                        don't merge search data subtrees
  --search-no-lookahead-barriers
                        don't insert search lookahead barriers
  --search-no-prefix-merging
                        don't merge search result prefixes
  --sort-globbed-files  sort globbed files for better reproducibility
  --debug               verbose debug output

Note that this docker image is a wrapper of m.css's doxygen.py script and does not configure your Doxyfile to work properly with m.css automatically. Make sure you follow the m.css doxygen quick start guide⁠.

The image points to my fork of m.css⁠, which patches the HTML generator and its templates to not include template information in class template members, reducing boilerplate in member documentation.

Tag summary

Content type

Image

Digest

Size

38.6 MB

Last updated

over 7 years ago

docker pull manu343726/mdotcss-doxygen