Align docs with the recent CLI changes #954
Merged
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
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
…move-again-project-free-command-to-outside
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
…n-docs-with-cli-change
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
vinnamkim
requested review from
chuneuny-emily,
sstrehlk,
sooahleex and
bonhunko
vinnamkim
commented
Apr 19, 2023
| @@ -418,8 +418,7 @@ Single commands are handy shorter alternatives for the most used commands | |||
| and also special commands, which are hard to be put into any specific context. | |||
| `Docker <https://www.docker.com/>`_ is an example of similar approach. | |||
|
|
|||
| .. raw:: html | |||
| :file: ../../../images/command_diag1.svg | |||
| .. graphviz:: command_line.dot | |||
There was a problem hiding this comment.
@yunchu
I updated GH actions to use graphviz in sphinx.
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## releases/1.2.0 #954 +/- ##
==================================================
- Coverage 78.70% 78.69% -0.02%
==================================================
Files 231 231
Lines 26420 26420
Branches 5258 5258
==================================================
- Hits 20794 20791 -3
- Misses 4401 4402 +1
- Partials 1225 1227 +2
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 1 file with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
wonjuleee
approved these changes
Apr 19, 2023
cih9088
approved these changes
Apr 20, 2023
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.
Summary
Since we move some commands from the top-level to
projectcontext. I updated the existing docs for this change. For example,Split commands doctree into: 1) Context-free
datum [command]and 2) Contextdatum <model|project|source|util> [command]Before
After
Fix docs hyperlinks according to this change.
How to test
Checklist
License
Feel free to contact the maintainers if that's a concern.