Skip to content

Conversation

dagardner-nv
Copy link
Contributor

@dagardner-nv dagardner-nv commented Mar 20, 2025

  • Add version number to the documentation title
  • Add -W flag to sphinx-build treating warnings as errors.
  • Remove performance hack, instead just set -j 4 (instead of auto).
  • Remove unused sphinx-build flags
  • linkcheck is now it's own make target

Remove performance hack, this always triggered a warning preventing us from using the `-W` flag

Signed-off-by: David Gardner <dagardner@nvidia.com>
…dd the -W flag, remove unneeded --fresh-env --write-all flags

Signed-off-by: David Gardner <dagardner@nvidia.com>
@dagardner-nv dagardner-nv added the doc Improvements or additions to documentation label Mar 20, 2025
@dagardner-nv dagardner-nv self-assigned this Mar 20, 2025
@dagardner-nv dagardner-nv requested a review from a team as a code owner April 1, 2025 19:50
@dagardner-nv dagardner-nv added the non-breaking Non-breaking change label Apr 1, 2025
…rsion-to-docs

Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
@dagardner-nv dagardner-nv changed the title Documentation improvements CI Documentation improvements Apr 1, 2025
@dagardner-nv
Copy link
Contributor Author

/merge

@rapids-bot rapids-bot bot merged commit 8cb2a78 into NVIDIA:develop Apr 1, 2025
9 checks passed
yczhang-nv pushed a commit to yczhang-nv/NeMo-Agent-Toolkit that referenced this pull request Apr 2, 2025
* Add version number to the documentation title
* Add `-W` flag to `sphinx-build` treating warnings as errors.
* Remove performance hack, instead just set `-j 4` (instead of auto).
* Remove unused `sphinx-build` flags
* `linkcheck` is now it's own make target

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)

URL: NVIDIA#24
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
ericevans-nv pushed a commit to ericevans-nv/agent-iq that referenced this pull request Apr 2, 2025
* Add version number to the documentation title
* Add `-W` flag to `sphinx-build` treating warnings as errors.
* Remove performance hack, instead just set `-j 4` (instead of auto).
* Remove unused `sphinx-build` flags
* `linkcheck` is now it's own make target

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)

URL: NVIDIA#24
Signed-off-by: Eric Evans <66225-erevans@users.noreply.gitlab-master.nvidia.com>
ericevans-nv pushed a commit to ericevans-nv/agent-iq that referenced this pull request Apr 14, 2025
* Add version number to the documentation title
* Add `-W` flag to `sphinx-build` treating warnings as errors.
* Remove performance hack, instead just set `-j 4` (instead of auto).
* Remove unused `sphinx-build` flags
* `linkcheck` is now it's own make target

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)

URL: NVIDIA#24
yczhang-nv pushed a commit to yczhang-nv/NeMo-Agent-Toolkit that referenced this pull request Apr 21, 2025
* Add version number to the documentation title
* Add `-W` flag to `sphinx-build` treating warnings as errors.
* Remove performance hack, instead just set `-j 4` (instead of auto).
* Remove unused `sphinx-build` flags
* `linkcheck` is now it's own make target

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)

URL: NVIDIA#24
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
yczhang-nv pushed a commit to yczhang-nv/NeMo-Agent-Toolkit that referenced this pull request May 8, 2025
* Add version number to the documentation title
* Add `-W` flag to `sphinx-build` treating warnings as errors.
* Remove performance hack, instead just set `-j 4` (instead of auto).
* Remove unused `sphinx-build` flags
* `linkcheck` is now it's own make target

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)

URL: NVIDIA#24
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
AnuradhaKaruppiah pushed a commit to AnuradhaKaruppiah/oss-agentiq that referenced this pull request Aug 4, 2025
* Add version number to the documentation title
* Add `-W` flag to `sphinx-build` treating warnings as errors.
* Remove performance hack, instead just set `-j 4` (instead of auto).
* Remove unused `sphinx-build` flags
* `linkcheck` is now it's own make target

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)

URL: NVIDIA#24
scheckerNV pushed a commit to scheckerNV/aiq-factory-reset that referenced this pull request Aug 22, 2025
* Add version number to the documentation title
* Add `-W` flag to `sphinx-build` treating warnings as errors.
* Remove performance hack, instead just set `-j 4` (instead of auto).
* Remove unused `sphinx-build` flags
* `linkcheck` is now it's own make target

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)

URL: NVIDIA#24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants