Repository navigation
Fix CLI docs #612
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Fix CLI docs #612
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
85f143b
Update dependencies
dc-almeida 66b84ac
Change dependencies to typer; add Typer sphinx plugin
dc-almeida 67235f4
Change import path
dc-almeida 775b175
Update scse-toolkit version constraint in pyproject.toml to allow for…
pmussak 6348c71
Add support for subannual dimension import in NomenclatureConfig (#619)
dc-almeida 9d07dc6
Merge branch 'main' into fix/cli-docs
dc-almeida ef869a6
Update dependencies
dc-almeida 339bc23
Add sphinx typer config
dc-almeida c25a2d6
Change path
dc-almeida 3ee95d2
Change app path
dc-almeida 560df3b
Fix CLI docs rendering
dc-almeida e0c27ae
Merge remote-tracking branch 'origin/main' into fix/cli-docs
dc-almeida 0590087
Poetry lock
dc-almeida 5adff88
Add CLI commands subpages
dc-almeida 6c555f8
Add toc heading
dc-almeida File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| Check region aggregation | ||
| ======================== | ||
|
|
||
| .. typer:: nomenclature.cli:app:check-region-aggregation | ||
| :prog: nomenclature check-region-aggregation | ||
| :preferred: svg | ||
| :make-sections: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| Convert Excel codelist to YAML | ||
| ============================== | ||
|
|
||
| .. typer:: nomenclature.cli:app:convert-xlsx-codelist-to-yaml | ||
| :prog: nomenclature convert-xlsx-codelist-to-yaml | ||
| :preferred: svg | ||
| :make-sections: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| Export definitions | ||
| ================== | ||
|
|
||
| .. typer:: nomenclature.cli:app:export-definitions | ||
| :prog: nomenclature export-definitions | ||
| :preferred: svg | ||
| :make-sections: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| List missing variables | ||
| ====================== | ||
|
|
||
| .. typer:: nomenclature.cli:app:list-missing-variables | ||
| :prog: nomenclature list-missing-variables | ||
| :preferred: svg | ||
| :make-sections: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| Parse model registration | ||
| ======================== | ||
|
|
||
| .. typer:: nomenclature.cli:app:parse-model-registration | ||
| :prog: nomenclature parse-model-registration | ||
| :preferred: svg | ||
| :make-sections: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| Run workflow | ||
| ============ | ||
|
|
||
| .. typer:: nomenclature.cli:app:run-workflow | ||
| :prog: nomenclature run-workflow | ||
| :preferred: svg | ||
| :make-sections: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| Validate project | ||
| ================ | ||
|
|
||
| .. typer:: nomenclature.cli:app:validate-project | ||
| :prog: nomenclature validate-project | ||
| :preferred: svg | ||
| :make-sections: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| Validate scenarios | ||
| ================== | ||
|
|
||
| .. typer:: nomenclature.cli:app:validate-scenarios | ||
| :prog: nomenclature validate-scenarios | ||
| :preferred: svg | ||
| :make-sections: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| Validate YAML | ||
| ============= | ||
|
|
||
| .. typer:: nomenclature.cli:app:validate-yaml | ||
| :prog: nomenclature validate-yaml | ||
| :preferred: svg | ||
| :make-sections: |
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
Large diffs are not rendered by default.
Oops, something went wrong.
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.