From b044cbea1b5bef44d7927e1a24365fed64446439 Mon Sep 17 00:00:00 2001 From: "Mads R. B. Kristensen" Date: Tue, 12 Sep 2023 14:05:56 +0200 Subject: [PATCH 1/2] minor doc fixes --- cpp/doxygen/main_page.md | 5 +++-- docs/source/index.rst | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/cpp/doxygen/main_page.md b/cpp/doxygen/main_page.md index a6120024ce..bf413ee125 100644 --- a/cpp/doxygen/main_page.md +++ b/cpp/doxygen/main_page.md @@ -8,7 +8,8 @@ KvikIO also works efficiently when GDS isn't available and can read/write both h 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. --- -**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/). + --- @@ -28,7 +29,7 @@ to include KvikIO in your CMake projects. ### Conda/Mamba -We strongly recommend using `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 diff --git a/docs/source/index.rst b/docs/source/index.rst index 86c08a78df..4dd491fd96 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,7 +10,7 @@ KvikIO is a part of the `RAPIDS `_ 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 `_. Contents From 5e71156d0810bb61dd51e5a88ac63660ca115458 Mon Sep 17 00:00:00 2001 From: "Mads R. B. Kristensen" Date: Wed, 13 Sep 2023 10:15:58 +0200 Subject: [PATCH 2/2] Update cpp/doxygen/main_page.md Co-authored-by: Lawrence Mitchell --- cpp/doxygen/main_page.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpp/doxygen/main_page.md b/cpp/doxygen/main_page.md index bf413ee125..e03c87b5d9 100644 --- a/cpp/doxygen/main_page.md +++ b/cpp/doxygen/main_page.md @@ -29,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) in place of conda, which we will do throughout the documentation. Install the **stable release** from the ``rapidsai`` channel with the following: ```sh