Skip to content

DASH v4.0.0 Beta 3

Compare
Choose a tag to compare
@JonKing93 JonKing93 released this 10 Aug 19:49
· 119 commits to main since this release

Summary

This release provides a complete HTML documentation reference guide for the toolbox.

Details

  1. This release includes a complete HTML reference guide for the toolbox. This reference guide is packaged directly with the toolbox, and is available offline. The HTML pages can be found in the doc folder of the toolbox.

  2. The reference guide can be accessed using the dash.doc command. Enter dash.doc in the Matlab console to open the front page of the documentation. Alternatively, enter dash.doc("<item name>") to open the documentation for a specific class, function, method, or package in the toolbox. For example: dash.doc("gridfile") or dash.doc("stateVector.build")

  3. The "Documentation Page" links in the help text are now fully functional. As an alternative to dash.doc, users can open the HTML documentation page for any item in the toolbox by entering: help <item name> in the console, and then clicking the "Documentation Page" link that appears at the end of the help text.

  4. Updated the documentation builders (in doc_source/reST parsers) from a prototype to fully functional tool. Improvements include:
    A. Restructured and simplified the layout of the functions
    B. Checks that help text is correctly formatted
    C. Informative errors that link to the problem file
    D. Documented all functions
    E. Added support for struct outputs and multiple struct fields

Next Steps

This reference guide is the essential core of the DASH toolbox's documentation and represents a complete (albeit basic) documentation set. Future updates should work to make the toolbox more approachable to first time users. In particular, future updates should add:

  1. Usage examples for all functions and methods, and
  2. Tutorials / Demos / FAQ pages

to the documentation.