Skip to content

docs: Enable docs self-publishing including nightly update#15432

Open
chtruong814 wants to merge 25 commits intomainfrom
chtruong/docs-publish
Open

docs: Enable docs self-publishing including nightly update#15432
chtruong814 wants to merge 25 commits intomainfrom
chtruong/docs-publish

Conversation

@chtruong814
Copy link
Collaborator

@chtruong814 chtruong814 commented Feb 24, 2026

What does this PR do ?

docs: Enable docs self-publishing including nightly update

  • Added initial uv.lock file. This is not used for any CI right now. Only for docs build but we will eventualy adapt Speech repo to use uv.
  • Fixed some docs issues during the build including resolving some docstring errors. Not sure why this wasn't being caught earlier
  • Updated main title to say NeMo Speech

Example dry run:
https://github.com/NVIDIA-NeMo/NeMo/actions/runs/22370634701

Published nightly docs:
https://docs.nvidia.com/nemo/speech/nightly/index.html

Collection: [Note which collection this PR will affect]

Changelog

  • Add specific line by line info of high level changes in this PR.

Usage

  • You can potentially add a usage example below
# Add a code snippet demonstrating how to use this 

GitHub Actions CI

The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.

The GitHub Actions CI will run automatically when the "Run CICD" label is added to the PR.
To re-run CI remove and add the label again.
To run CI on an untrusted fork, a NeMo user with write access must first click "Approve and run".

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you add or update any necessary documentation?
  • Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
    • Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

  • New Feature
  • Bugfix
  • Documentation

If you haven't finished some of the above items you can still open "Draft" PR.

Who can review?

Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.

Additional Information

  • Related to # (issue)

Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
This reverts commit 1c3aa19.

Signed-off-by: Charlie Truong <chtruong@nvidia.com>
This reverts commit 43c19ae.

Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
This reverts commit a28f306.

Signed-off-by: Charlie Truong <chtruong@nvidia.com>
This reverts commit 9353dcb.

Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Copy link
Collaborator

@pzelasko pzelasko left a comment

Choose a reason for hiding this comment

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

Looks good to me, but do we need uv.lock file to be present in the repo?

This reverts commit 9c8e7a4.

Signed-off-by: Charlie Truong <chtruong@nvidia.com>
This reverts commit 850207e.

Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
This reverts commit 05894f2.

Signed-off-by: Charlie Truong <chtruong@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants