From 8c56e6c89202b0a7380e603a564d3aa999e19e1f Mon Sep 17 00:00:00 2001
From: Sam Wu <sam.wu2@amd.com>
Date: Thu, 16 Mar 2023 13:12:43 -0600
Subject: [PATCH] Fix Docs static analysis (#708)

* remove ref to old script in static analysis

* update README with doc build instructions

update gitignore with doc artifacts
---
 .gitignore                     | 10 +++++++++-
 .jenkins/staticanalysis.groovy | 22 ----------------------
 README.md                      | 12 ++++++++++++
 3 files changed, 21 insertions(+), 23 deletions(-)

diff --git a/.gitignore b/.gitignore
index 87ad949eb4..402fdcc8e9 100644
--- a/.gitignore
+++ b/.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/.jenkins/staticanalysis.groovy b/.jenkins/staticanalysis.groovy
index aa5fec3b4a..7d1c5ea431 100644
--- a/.jenkins/staticanalysis.groovy
+++ b/.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/README.md b/README.md
index 1b8db6a456..cbd927c21c 100644
--- a/README.md
+++ b/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.