Fix docs errors and most warnings #9006
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: Elena Rastorgueva <erastorgueva@nvidia.com>
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com>
Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>
yaoyu-33
approved these changes
May 1, 2024
suiyoubi
pushed a commit
that referenced
this pull request
May 2, 2024
* add various docs fixes Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> * make conf.py changes clearer Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> * fix Duplicate explicit target name error for links Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> * more fixes, mainly citations Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> * fix some code formatting Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> * update hf space iframe link Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> * fix new ERRORs Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> * Update docs Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> --------- Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> Co-authored-by: yaoyu-33 <yaoyu.094@gmail.com> Co-authored-by: Eric Harper <complex451@gmail.com> Signed-off-by: Ao Tang <aot@nvidia.com>
rohitrango
pushed a commit
to rohitrango/NeMo
that referenced
this pull request
Jun 25, 2024
* add various docs fixes Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> * make conf.py changes clearer Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> * fix Duplicate explicit target name error for links Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> * more fixes, mainly citations Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> * fix some code formatting Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> * update hf space iframe link Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> * fix new ERRORs Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> * Update docs Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> --------- Signed-off-by: Elena Rastorgueva <erastorgueva@nvidia.com> Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> Co-authored-by: yaoyu-33 <yaoyu.094@gmail.com> Co-authored-by: Eric Harper <complex451@gmail.com>
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.
What does this PR do ?
Fix all current doc-building errors and most warnings. I have not fixed all warnings in the interest of making the PR not too large, and have tried to avoid making some changes that might conflict with @yaoyu-33 's current work on improving the doc structure.
FAO @titu1994 : please look over the changes to
docs/source/conf.py. I removed the duplicate "sphinxcontrib.bibtex" extension. I have also commented out the "sphinx.ext.autosectionlabel" extension as that was causing a lot of "duplicate label" warnings.Collection: Docs
Changelog
Usage
# Add a code snippet demonstrating how to use thisJenkins CI
The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.
There's no need to comment
jenkinson the PR to trigger Jenkins CI.The GitHub Actions CI will run automatically when the PR is opened.
To run CI on an untrusted fork, a NeMo user with write access must click "Approve and run".
Before your PR is "Ready for review"
Pre checks:
PR Type:
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