diff --git a/projects/rccl/.gitignore b/projects/rccl/.gitignore index 87ad949eb4..402fdcc8e9 100644 --- a/projects/rccl/.gitignore +++ b/projects/rccl/.gitignore @@ -1,4 +1,12 @@ # Copyright (c) 2015-2016, NVIDIA CORPORATION. All rights reserved. -/build *.gcov /coverage/ + +# documentation artifacts +build/ +_build/ +_images/ +_static/ +_templates/ +_toc.yml +docBin/ diff --git a/projects/rccl/.jenkins/staticanalysis.groovy b/projects/rccl/.jenkins/staticanalysis.groovy index aa5fec3b4a..7d1c5ea431 100644 --- a/projects/rccl/.jenkins/staticanalysis.groovy +++ b/projects/rccl/.jenkins/staticanalysis.groovy @@ -12,28 +12,6 @@ import java.nio.file.Path def runCompileCommand(platform, project, jobName, boolean debug=false) { project.paths.construct_build_prefix() - - def command = """#!/usr/bin/env bash - set -x - ${project.paths.project_build_prefix}/docs/run_doc.sh - """ - - try - { - platform.runCommand(this, command) - } - catch(e) - { - throw e - } - - publishHTML([allowMissing: false, - alwaysLinkToLastBuild: false, - keepAll: false, - reportDir: "${project.paths.project_build_prefix}/docs/source/_build/html", - reportFiles: "index.html", - reportName: "Documentation", - reportTitles: "Documentation"]) } def runCI = diff --git a/projects/rccl/README.md b/projects/rccl/README.md index 1b8db6a456..cbd927c21c 100644 --- a/projects/rccl/README.md +++ b/projects/rccl/README.md @@ -110,6 +110,18 @@ To manually analyze NPKit dump results, please leverage [npkit_trace_generator.p Please refer to the [Library documentation](https://rccl.readthedocs.io/) for current documentation. +### How to build documentation + +Run the steps below to build documentation locally. + +``` +cd docs + +pip3 install -r .sphinx/requirements.txt + +python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html +``` + ## Copyright All source code and accompanying documentation is copyright (c) 2015-2022, NVIDIA CORPORATION. All rights reserved.