docs: add plug-in for dataset management examples auto generation #532
Conversation
This file contains 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
linjiX
requested changes
May 12, 2021
| # Copyright 2021 Graviti. Licensed under MIT License. | ||
| # | ||
|
|
||
| """plugins.""" |
There was a problem hiding this comment.
Capitalized the modulestring
|
|
||
| def _get_label_types(self) -> List[str]: | ||
| label_types = self._dataset_client.get_catalog().dumps().keys() | ||
| capitalized_types = [type_.capitalize() for type_ in label_types] |
There was a problem hiding this comment.
build a map for the label_types transfer?
| _SOURCE_PATH = os.path.join(REPO_PATH, "docs", "source") | ||
| _EXAMPLES_PATH = os.path.join(_SOURCE_PATH, "examples") | ||
| _IMAGES_PATH = os.path.join(_SOURCE_PATH, "images") | ||
| _TEMPLATE_PATH = os.path.join(_EXAMPLES_PATH, "template.json") |
There was a problem hiding this comment.
it is not a good idea to put template into a json file.
| self._load_delete_dataset() | ||
|
|
||
| def _load_top(self) -> None: | ||
| self._create_and_add_title(self._alias, self._TOPMOST_TITLE_LEVEL) |
There was a problem hiding this comment.
try to use docutils or sphinx to write the rst file
Pull Request Test Coverage Report for Build 835877504
💛 - Coveralls |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.