Documentation cherry-pick for 5.6 (#292)

* Updated docs to use the ROCm standard (#276)

* improved api docs

* add introduction and installing pages to docs

* pin docs dependencies

* install deps via requirements.txt

* fix typo

* Updated docs to the ROCm standard

* Updated CHANGELOG.md

* Removed redundant FILE_PATTERNS

* Fixed requirements

* Fixed gitignore

---------

Co-authored-by: Robin Voetter <robin@streamhpc.com>
Co-authored-by: Nol Moonen <nol@streamhpc.com>

* Add dependabot config and pin rocm-docs-core (#277)

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

* Fix dependabot file structure (#278)

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

* Update documentation and dependabot.yml config (#279)

* Update dependabot config

* reorder toc

* remove step to build old docs in jenkins

* add in missing pages; remove unused scripts and assets

* Update version string (#283)

* Fix warnings during compilation (#269)

* Update deprecated builtins

* Fix more deprecated builtin calls

* Fixing warnings

* Update to __is_trivially_copyable(T)

* Fix typo to __is_trivially_constructible

* Update documentation requirements (#285)

Co-authored-by: samjwu <samjwu@users.noreply.github.com>

* Bump requests from 2.28.2 to 2.31.0 in /docs/.sphinx (#287)

Bumps [requests](https://github.com/psf/requests) from 2.28.2 to 2.31.0.
- [Release notes](https://github.com/psf/requests/releases)
- [Changelog](https://github.com/psf/requests/blob/main/HISTORY.md)
- [Commits](psf/requests@v2.28.2...v2.31.0)

---
updated-dependencies:
- dependency-name: requests
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump rocm-docs-core from 0.11.0 to 0.13.1 in /docs/.sphinx (#291)

Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.11.0 to 0.13.1.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](ROCm/rocm-docs-core@v0.11.0...v0.13.1)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update changelog for 5.6

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Lőrinc Serfőző <mfep@users.noreply.github.com>
Co-authored-by: Robin Voetter <robin@streamhpc.com>
Co-authored-by: Nol Moonen <nol@streamhpc.com>
Co-authored-by: Sam Wu <sam.wu2@amd.com>
Co-authored-by: samjwu <samjwu@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# 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
+    open-pull-requests-limit: 10
+    schedule:
+      interval: "daily"

.gitignore

@@ -6,9 +6,6 @@ doc/html/
 doc/xml/
 doc/latex/
 doc/*.tag
-docs/_build/
-docs/api/
-docs/docBin/
 
 # Created by https://www.gitignore.io/api/c++,cmake
 

.gitlab-ci.yml

@@ -8,6 +8,7 @@ include:
     file:
       - /defaults.yaml
       - /deps-cmake.yaml
+      - /deps-docs.yaml
       - /deps-rocm.yaml
       - /gpus-rocm.yaml
       - /rules.yaml
@@ -159,17 +160,10 @@ test:package:
     - $SUDO_CMD dpkg -r rocprim-dev
 
 test:doc:
-  image: sphinxdoc/sphinx-latexpdf
-  needs: []
   stage: test
   extends:
+    - .build:docs
     - .rules:test
-  before_script:
-    - $SUDO_CMD apt update -qq
-    - $SUDO_CMD apt install -y -qq doxygen
-    - $SUDO_CMD pip3 install sphinx_rtd_theme breathe exhale
-  script:
-    - bash -x $CI_PROJECT_DIR/docs/run_doc.sh
 
 test:
   stage: test

.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/_build/html",
-                reportFiles: "index.html",
-                reportName: "Documentation",
-                reportTitles: "Documentation"])
 }
 
 def runCI = 

.readthedocs.yml

@@ -1,24 +1,14 @@
-# .readthedocs.yml
 # Read the Docs configuration file
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
-# Required
 version: 2
 
-# Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
 
-# Build documentation with MkDocs
-#mkdocs:
-#  configuration: mkdocs.yml
+formats: [htmlzip]
 
-# Optionally build your docs in additional formats such as PDF and ePub
-formats: all
-
-# Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.7
+  version: 3.8
   install:
-    - requirements: docs/requirements.txt
-
+    - requirements: docs/.sphinx/requirements.txt

CHANGELOG.md

@@ -2,11 +2,13 @@
 
 Full documentation for rocThrust is available at [https://rocthrust.readthedocs.io/en/latest/](https://rocthrust.readthedocs.io/en/latest/)
 
-## (Unreleased) rocThrust 2.18.0 for ROCm 5.6
+## rocThrust 2.18.0 for ROCm 5.6
 ### Fixed 
 - `lower_bound`, `upper_bound`, and `binary_search` failed to compile for certain types.
+### Changed
+- Updated `docs` directory structure to match the standard of [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core).
 
-## (Unreleased) rocThrust 2.17.0 for ROCm 5.5
+## rocThrust 2.17.0 for ROCm 5.5
 ### Added
 - Updated to match upstream Thrust 1.17.2
 ### Fixed

CMakeLists.txt

@@ -133,7 +133,7 @@ if(BUILD_ADDRESS_SANITIZER)
 endif()
 
 # Setup VERSION
-rocm_setup_version(VERSION "2.10.9")
+rocm_setup_version(VERSION "2.18.0")
 
 # Print configuration summary
 include(cmake/Summary.cmake)

README.md

@@ -221,6 +221,23 @@ make -j4
 
 Documentation is available [here](https://rocthrust.readthedocs.io/en/latest/).
 
+It can also be build using the following commands:
+
+```shell
+# Go to rocThrust docs directory
+cd rocThrust; cd docs
+
+# Install Python dependencies
+python3 -m pip install -r .sphinx/requirements.txt
+
+# Build the documentation
+python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
+
+# For e.g. serve the HTML docs locally
+cd _build/html
+python3 -m http.server
+```
+
 ## Support
 
 Bugs and feature requests can be reported through [the issue tracker](https://github.com/ROCmSoftwarePlatform/rocThrust/issues).