Doxygen vs MkDocs

Doxygen is a free documentation generator that turns source-code comments into reference material, parsing items such as classes, functions and variables. It supports C/C++, Lex, Java, Python, VHDL, PHP IDL, C#, Fortran, Objective-C 2.0 and some D sources. Output can be generated as HTML, PDF through LaTeX, Word through RTF or structured XML for external tools. Graphviz’s dot tool can add include-dependency, collaboration, call, directory-structure and class-hierarchy diagrams. Doxywizard provides a graphical interface for editing settings and running the generator on Windows, Linux and macOS; Doxygen also works on many Unix flavors. It supports HTML Help, docsets, Qt-Help and Eclipse Help, with more than 100 configurable options. The tool runs without registration and does not collect personal or usage data. It is self-hosted and licensed under the GNU General Public License, without express or implied warranty. Help is listed through Stack Overflow and the doxygen users mailing list; commercial feature and bug-fix support has limited capacity.

MkDocs is a static site generator for project documentation written in Markdown, with project settings held in a YAML file. It produces static HTML that can be published to GitHub Pages, Amazon S3, or another static-file host. Its development server provides a local preview and refreshes it when documentation changes; generated sites also include search that can link to matching sections. The command-line tools cover creating a project, serving a preview, building the site, checking dependencies, and deploying to GitHub Pages. MkDocs uses Python-Markdown and requires a recent Python version and pip. The built-in mkdocs and readthedocs themes are available alongside third-party and custom themes, while plugins, Markdown extensions, and configuration options allow further changes. The built-in mkdocs theme supports several locales, including English, German, Spanish, French, Japanese, and Chinese. MkDocs is free, available for Linux, macOS, Windows, and self-hosted use, and distributed under the BSD license. Third-party themes and plugins run their authors’ code without sandboxing.