Updating MLCube documentation [WIP]#278
Merged
sergey-serebryakov merged 8 commits intoDec 6, 2022
Merged
Conversation
This commit introduces several features: - Documentation for MLCube system settings configuration. - Automatic documentation generation for MLCube command line interface. This is done using `mkdocs-click` extension (what implies that mkdocs requirements now include mlcube requirements). How to test the new documentation: - Clone, create python virtual environment. - Install requirements: `pip install mkdocs-requirements.txt` - Run mkdocs server: `mkdocs serve`. Due to browser caching feature, if you do not see new pages (System Settings and Command Line Interface) in the Getting Started section, reload the page with Ctrl-F5 to bypass browser cache.
Contributor
|
MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅ |
- Adding support to remove markdown syntax when print help message on a console. - Updating help messages for MLCube commands and their options. In particular, adding custom epilogues to click commands that show usage examples. - Transitioning from arguments for configuration parameters to options (-P/-p).
…le (cli.py). Adding unit test for CLI classes.
Updating protobuf verison from 3.20.1 to 3.20.3.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit introduces several features:
mkdocs-clickplugin (what implies that mkdocs requirements now include mlcube requirements).How to test the new documentation:
pip install mkdocs-requirements.txtmkdocs serve.Due to browser caching feature, if you do not see new pages (System Settings and Command Line Interface) in the Getting Started section, reload the page with Ctrl-F5 to bypass browser cache.