Docsupdate (#1748)

Co-authored-by: Sam Wu <[email protected]>
Co-authored-by: Paul <[email protected]>

.dockerignore

@@ -5,5 +5,5 @@
 !*.txt
 !*.ini
 !/tools/*.sh
-!/doc/*.txt
 !/test/onnx/.onnxrt-commit
+!/docs/.sphinx/*.txt

.github/dependabot.yml

@@ -0,0 +1,27 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/docs/.sphinx" # Location of package manifests
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "pip"
+    directory: "/tools/accuracy"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "pip"
+    directory: "/examples/vision/python_unet"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "pip"
+    directory: "/examples/vision/python_super_resolution"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/ci.yaml

@@ -236,7 +236,7 @@ jobs:
     - name: Run pyflakes
       run: |
         pyflakes --version
-        pyflakes examples/ tools/ src/ test/ doc/
+        pyflakes examples/ tools/ src/ test/ docs/
         mypy --version
         mypy tools/api.py
 

.gitignore

@@ -48,6 +48,8 @@
 
 /CMakeSettings.json
 
+# documentation artifacts
+_toc.yml
 
 #==============================================================================#
 # Directories to ignore (do not add trailing '/'s, they skip symlinks).
@@ -61,3 +63,12 @@ test/onnx/models
 # VS2017 and VSCode config files.
 .vscode
 .vs
+
+# documentation artifacts
+docs/_build
+docs/_images
+docs/_static
+docs/_templates
+docs/.doxygen/docBin
+docs/_doxygen
+/_readthedocs

.readthedocs.yaml

@@ -0,0 +1,14 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+sphinx:
+   configuration: docs/conf.py
+
+formats: [htmlzip]
+
+python:
+   version: "3.8"
+   install:
+   - requirements: docs/.sphinx/requirements.txt

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log for MIGraphX
 
-Full documentation for MIGraphX is available at [MIGraphX Github Pages](https://rocmsoftwareplatform.github.io/AMDMIGraphX/doc/html/).
+Full documentation for MIGraphX is available at [MIGraphX Documentation](https://rocmdocs.amd.com/projects/AMDMIGraphX/en/latest/).
 
 ## MIGraphX 2.5 for ROCm 5.5.0
 

CMakeLists.txt

@@ -268,7 +268,7 @@ set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/lib)
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/lib)
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin)
 add_subdirectory(src)
-add_subdirectory(doc)
+add_subdirectory(docs)
 add_subdirectory(test)
 add_subdirectory(tools)
 

Dockerfile

@@ -83,7 +83,7 @@ RUN test -f /usr/local/hash || exit 1
 RUN pip3 install yapf==0.28.0
 
 # Install doc requirements
-ADD doc/requirements.txt /doc-requirements.txt
+ADD docs/.sphinx/requirements.txt /doc-requirements.txt
 RUN pip3 install -r /doc-requirements.txt
 
 # Download real models to run onnx unit tests
@@ -120,4 +120,3 @@ ENV LD_LIBRARY_PATH=$PREFIX/lib
 ENV UBSAN_OPTIONS=print_stacktrace=1
 ENV ASAN_OPTIONS=detect_stack_use_after_return=1:check_initialization_order=1:strict_init_order=1
 RUN ln -s /opt/rocm/llvm/bin/llvm-symbolizer /usr/bin/llvm-symbolizer
-

Jenkinsfile

@@ -30,6 +30,7 @@ def rocmtestnode(Map conf) {
             cd build
             cmake -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DBUILD_DEV=On ${flags} ..
             make -j\$(nproc) generate all doc package check VERBOSE=1
+            md5sum ./*.deb
         """
         echo cmd
         sh cmd
@@ -147,7 +148,8 @@ rocmtest onnx: onnxnode('rocmtest') { cmake_build ->
     stage("Onnx runtime") {
         sh '''
             apt install half
-            ls -lR
+            #ls -lR
+            md5sum ./build/*.deb
             dpkg -i ./build/*.deb
             cd /onnxruntime && ./build_and_test_onnxrt.sh
         '''

README.md

@@ -203,13 +203,19 @@ HTML and PDF documentation can be built using:
 
 `cmake --build . --config Release --target doc` **OR** `make doc`
 
-This will build a local searchable web site inside the doc/html folder.
+This will build a local searchable web site inside the docs/html folder.
 
-Documentation is built using [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html), [Sphinx](http://www.sphinx-doc.org/en/stable/index.html), and [Breathe](https://breathe.readthedocs.io/en/latest/)
+Documentation is built using [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html) and [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core)
 
-Requirements for both Sphinx and Breathe can be installed with:
+Run the steps below to build documentation locally.
 
-`pip install -r doc/requirements.txt`
+```
+cd docs
+
+pip3 install -r .sphinx/requirements.txt
+
+python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
+```
 
 Depending on your setup `sudo` may be required for the pip install.