Add Jenkins docs build (#18)

* Fix typo in copyright

* Minor README improvements

- Prevent underscores from being interpreted as italics in test name format.
- Switch URL to HTTPS.

* Update docs scripts config

- Allow run_doc.sh and run_doxygen.sh to be called from any directory.

* Add docs build to Jenkins

docs/run_doc.sh

@@ -1,17 +1,15 @@
 #!/bin/bash
-# Copyright (c) 2019-2020 Advanced Micro Devices, Inc. All rights reserved.
+# Copyright (c) 2019-2021 Advanced Micro Devices, Inc. All rights reserved.
 
-if [ -d docBin ]; then
-    rm -rf docBin
-fi
+set -eu
 
-sed -e 's/ROCFFT_EXPORT //g' ../library/include/rocfft.h > rocfft.h
-doxygen Doxyfile
+# Make this directory the PWD
+cd "$(dirname "${BASH_SOURCE[0]}")"
 
+# Build doxygen info
+./run_doxygen.sh
+
+# Build sphinx docs
 cd source
 make clean
 make html
-cd ..
-
-rm rocfft.h
-

docs/run_doxygen.sh

@@ -1,13 +1,17 @@
 #!/bin/bash
-# # Copyright (c) 2019-2020 Advanced Micro Devices, Inc. All rights reserved.
+# # Copyright (c) 2019-2021 Advanced Micro Devices, Inc. All rights reserved.
 
-if [ -d docBin ]; then
-    rm -rf docBin
-fi
+set -eu
 
-rm nccl.h
+# Make this directory the PWD
+cd "$(dirname "${BASH_SOURCE[0]}")"
 
-sed -e 's/ROCFFT_EXPORT //g' ../src/nccl.h.in > nccl.h
+# Rename our input file
+cp ../src/nccl.h.in nccl.h
+
+# Build the doxygen info
+rm -rf docBin
 doxygen Doxyfile
-#rm nccl.h
 
+# Cleanup
+rm nccl.h

docs/source/conf.py

@@ -56,8 +56,8 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'RCCL'
-copyright = u'2015-2018, NVIDIA CORPORATION; Modifications Copyright 2019-2020 Advanced Mirco Devices'
-author = u'Advanced Mirco Devices'
+copyright = u'2015-2018, NVIDIA CORPORATION; Modifications Copyright 2019-2020 Advanced Micro Devices'
+author = u'Advanced Micro Devices'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -156,7 +156,7 @@ latex_elements = {
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc, 'RCCL.tex', u'RCCL Documentation',
-     u'Advanced Mirco Devices', 'manual'),
+     u'Advanced Micro Devices', 'manual'),
 ]