Skip to content

Commit

Permalink
Updated docs to use the ROCm standard (#276)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
3 people authored and samjwu committed Jun 13, 2023
1 parent 92ce6aa commit 7f6ae50
Show file tree
Hide file tree
Showing 21 changed files with 549 additions and 670 deletions.
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 2 additions & 8 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ include:
file:
- /defaults.yaml
- /deps-cmake.yaml
- /deps-docs.yaml
- /deps-rocm.yaml
- /gpus-rocm.yaml
- /rules.yaml
Expand Down Expand Up @@ -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
Expand Down
16 changes: 3 additions & 13 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -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
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

Full documentation for rocThrust is available at [https://rocthrust.readthedocs.io/en/latest/](https://rocthrust.readthedocs.io/en/latest/)

## rocThrust 2.17.0 for ROCm 5.5
## (Unreleased) 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
### Added
- Updated to match upstream Thrust 1.17.2
### Fixed
Expand Down
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Loading

0 comments on commit 7f6ae50

Please sign in to comment.