Skip to content

Commit 299e8c0

Browse files
ahmadkilbliii
andauthored
docs: Added CLI documentation (#444)
* Document the CLI parameters and default values * Use markdown when printing CLI help * Print parameter's required, optional and defaults fields * tests for default parameter values and formatting * Added "CLI Command Reference" page to the documentation Closes #228 and #382 --------- Signed-off-by: Ahmad Kiswani <kiswani.ahmad@gmail.com> Signed-off-by: Lawrence Lane <llane@nvidia.com> Co-authored-by: Lawrence Lane <llane@nvidia.com>
1 parent c34cfe1 commit 299e8c0

File tree

8 files changed

+1022
-18
lines changed

8 files changed

+1022
-18
lines changed

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,13 @@ tutorials/rl-training-with-nemo-rl
163163
how-to-faq.md
164164
```
165165

166+
```{toctree}
167+
:caption: Reference
168+
:hidden:
169+
:maxdepth: 1
170+
171+
reference/cli-commands.md
172+
```
166173

167174
```{toctree}
168175
:caption: Development

0 commit comments

Comments
 (0)