bio_img_pick

Pick of the Week

Recognizing outstanding contributions from the MATLAB ecosystem

MATLAB DocMaker: making it easier to create documentation for your MATLAB toolbox

Mike's pick this week is MATLAB DocMaker by David Sampson.
Many of the toolboxes featured on Pick Of The Week include superb documentation that integrates with MATLAB's documentation system. They appear in a section called 'Supplemental Software' and here's that section in my MATLAB. You'll recognize a couple of picks from last year such as FSDA Toolbox and k-Wave in the list along with a couple you haven't seen before.
'Koch Toolbox' is a toy I made for myself to see how easy it was to use today's pick: MATLAB DocMaker toolbox.
It was pretty easy! After installing DocMaker toolbox and connecting it to GitHub (The current version of the toolbox makes use of the GitHub Markdown API), all I needed to do was write a couple of Markdown Files and then ask DocMaker to do its magic. Three commands later and I was done.
DocMaker even uses itself to generate its own documentation, which is also available on GitHub.
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
It also has a cute logo.
DocMaker requires MATLAB R2021a or later to generate documentation but the resulting docs can be viewed offline and in much older MATLAB releases. Check it out on File Exchange and GitHub.
|
  • print

コメント

コメントを残すには、ここ をクリックして MathWorks アカウントにサインインするか新しい MathWorks アカウントを作成します。