Skip to content

Commit

Permalink
minor doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
madsbk committed Sep 12, 2023
1 parent 06d9ec9 commit b403887
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
7 changes: 4 additions & 3 deletions cpp/doxygen/main_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ bindings to [cuFile](https://docs.nvidia.com/gpudirect-storage/api-reference-gui
which enables [GPUDirect Storage (GDS)](https://developer.nvidia.com/blog/gpudirect-storage/).
KvikIO also works efficiently when GDS isn't available and can read/write both host and device data seamlessly.

KvikIO C++ is a header-only library that is part of the [RAPIDS](https://rapids.ai/) suite of open-source software libraries for GPU-accelerated data science.
KvikIO C++ is a header-only library that is part of the suite of open-source software libraries for GPU-accelerated data science.

---
**Notice** this is the documentation for the C++ library. For the Python documentation of KvikIO, see under **KvikIO**.
**Notice** this is the documentation for the C++ library. For the Python documentation, see under [kvikio](https://docs.rapids.ai/api/kvikio/nightly/).


---

Expand All @@ -28,7 +29,7 @@ to include KvikIO in your CMake projects.

### Conda/Mamba

We strongly recommend using `mamba <https://github.com/mamba-org/mamba>`_ inplace of conda, which we will do throughout the documentation.
We strongly recommend using [mamba](https://github.com/mamba-org/mamba) inplace of conda, which we will do throughout the documentation.

Install the **stable release** from the ``rapidsai`` channel with the following:
```sh
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ KvikIO is a part of the `RAPIDS <https://rapids.ai/>`_ suite of open-source soft


.. note::
This is the documentation for the Python library. For the C++ documentation of KvikIO, see under **libkvikio**.
This is the documentation for the Python library. For the C++ documentation, see under `libkvikio <https://docs.rapids.ai/api/libkvikio/nightly/>`_.


Contents
Expand Down

0 comments on commit b403887

Please sign in to comment.