For major changes, please open an issue first to discuss what you would like to change. Mkdocs.yml: site_name : "My MkDoxy documentation" theme : name : material plugins : - search - mkdoxy : projects : myProjectCpp : # name of project must be alphanumeric + numbers (without spaces) src-dirs : path/to/src/project1 # path to source code (support multiple paths separated by space) => INPUT full-doc : True # if you want to generate full documentation doxy-cfg : # standard doxygen configuration (key: value) FILE_PATTERNS : "*.cpp *.h*" # specify file patterns to filter out RECURSIVE : True # recursive search in source directories Contributing Install the plugin using pip from PyPI: pip install mkdoxyĭevelopment version with all dependencies: python -m pip install mkdoxy "." Custom Doxygen configuration: Specify custom Doxygen configuration for each project. I have a complex python-selenium test suite (using py.test) in a folder, and I waht to use doxygen to generate a documentation of all files (and, more importantly, the call graphs of what method is calling what method etc.).Custom Jinja templates: Define custom Jinja templates for rendering Doxygen documentation.Multiple source directories: Configure multiple source directories in one project.Multiple projects: Support for multiple projects in one documentation (e.g. Code snippets: Generate code snippets in place of your standard Markdown documentation.Easy to use:: Just add mkdoxy to your mkdocs.yml and configure the path to your source code.With this, Doxysphinx supports all known Doxygen features and at the same time integrates well with the Sphinx output. It reuses the Doxygen generated HTML output and integrates it into Sphinx document generation. It is an easy-to-use cli tool and typically runs right after Doxygen generation. :material-home-edit: Online Demo and :simple-github: Demo source-codeįeature List - Installation - Quick start Feature List Doxysphinx is a Doxygen and Sphinx integration tool. More information in Discussions and Issues pages. Warning Extension is in development and few features are not working properly. MkDoxy plugin for MkDocs generates API documentation based on Doxygen comments and code snippets in your markdown files.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |