Generating Dash Docset¶
These instructions are for creating a docset based on the RSMTool documentation to be used for the macOS Dash app.
- If you have created/deleted any documentation files, update the variable
FILES_TO_MODIFYat the top of the file
doc/add_dash_anchors.pyto reflect these changes.
make dashin the
docdirectory. This will compile the HTML documentation using the Alabaster theme (which is better suited for this purpose), run
add_dash_anchors.pyfor Dash TOC support, and create the docset file (
- Clone the repository at https://github.com/Kapeli/Dash-User-Contributions.
- Follow the instructions in that repository’s README. Note that we do not need add explicit icons for the docset since our icon is already included in the docset file created above. Make sure to submit a pull request to that repo in the end!