Skip to content

DocMaker is a tool for generating MATLAB toolbox documentation.

License

Notifications You must be signed in to change notification settings

mathworks/docmaker

MATLAB® DocMaker 🐣

DocMaker is a tool for generating MATLAB toolbox documentation.

With DocMaker, you can:

  • write documentation in Markdown and convert to HTML for viewing in MATLAB
  • run MATLAB code blocks in documents and include textual and graphical output
  • create MATLAB documentation index files from a Markdown table of contents

DocMaker requires MATLAB R2021a or later to generate documentation. Documentation generated by DocMaker can be viewed in much older releases of MATLAB, and offline.

User documentation

DocMaker ships with documentation that you can browse online, including:

Developer documentation

The repository contains a top-level MATLAB project. Developers should follow the user setup instructions by generating a GitHub access token and registering the token with MATLAB.

Development requires the MATLAB Build Tool which was introduced in MATLAB R2022b. Tasks are provided to:

  • check: identify code issues
  • test: run unit tests
  • doc: generate documentation
  • package: package as a MATLAB Toolbox file (.mltbx)
  • clean: delete derived artifacts

About

DocMaker is developed by David Sampson at MathWorks.

DocMaker uses the GitHub Markdown API at github.com, and the GitHub Markdown CSS by Sindre Sorhus.

The author thanks Ken Deeley from MathWorks for his support during the development of DocMaker.


©️ MathWorks 2024-2026

About

DocMaker is a tool for generating MATLAB toolbox documentation.

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •