Skip to content

Conversation

@aschilling-nv
Copy link
Contributor

This MR moves the source Markdown files out of the source folder and directly into the docs folder to match the layout of other framework libraries. It also added a documentation.md to help users build and view documentation locally. I've also reviewed and converted notes into rendered notes and adjusted the TOC trees to a more suitable layout. Additional Sphinx extensions have been installed to help with UX/UI issues.

Adds two new Sphinx extensions:

  • sphinx_copybutton (Code block copy button)
  • sphinx_new_tab_link (Opens external links in a new tab)
  • Enables MyST extensions

Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
@aschilling-nv aschilling-nv self-assigned this Oct 7, 2025
@aschilling-nv aschilling-nv added the documentation Improvements or additions to documentation label Oct 7, 2025
],
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true
"python.testing.pytestEnabled": true,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It picked up my VSCode settings and I removed them, but I must have forgotten the ",". I can remove it, which makes it easier. Just let me know.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah let's remove changes to this file in this PR. Can follow up in a separate PR if needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed!

Copy link

@jgerh jgerh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checked documentation restructuring - no changes.

Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
@hemildesai hemildesai merged commit 0c68809 into main Oct 7, 2025
21 of 22 checks passed
@leoleoasd
Copy link

The links in readme.md are not updated

Run/README.md

Line 30 in 8ca8f79

Please see this [detailed guide](./docs/source/guides/why-use-nemo-run.md) for reasons to use NeMo Run.

@aschilling-nv
Copy link
Contributor Author

The links in readme.md are not updated

Run/README.md

Line 30 in 8ca8f79

Please see this [detailed guide](./docs/source/guides/why-use-nemo-run.md) for reasons to use NeMo Run.

PR to correct the issue: #366

zoeyz101 pushed a commit to zoeyz101/NeMo-Run that referenced this pull request Nov 12, 2025
* Fixing documentation layout

Signed-off-by: Andrew Schilling <aschilling@nvidia.com>

* documentation.md

Signed-off-by: Andrew Schilling <aschilling@nvidia.com>

* Removing live-server

Signed-off-by: Andrew Schilling <aschilling@nvidia.com>

* Correctin .vscode

Signed-off-by: Andrew Schilling <aschilling@nvidia.com>

---------

Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
Signed-off-by: Zoey Zhang <zozhang@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants