From a51cbc33684ea1097676578796faba5367a81e42 Mon Sep 17 00:00:00 2001 From: Mark Harris Date: Tue, 16 Apr 2024 04:10:19 +0000 Subject: [PATCH 01/15] Remove thrust_rmm_allocator.h --- include/rmm/thrust_rmm_allocator.h | 55 ------------------------------ 1 file changed, 55 deletions(-) delete mode 100644 include/rmm/thrust_rmm_allocator.h diff --git a/include/rmm/thrust_rmm_allocator.h b/include/rmm/thrust_rmm_allocator.h deleted file mode 100644 index ad71e107a..000000000 --- a/include/rmm/thrust_rmm_allocator.h +++ /dev/null @@ -1,55 +0,0 @@ -/* - * Copyright (c) 2018-2021, NVIDIA CORPORATION. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#pragma once - -#include -#include -#include -#include - -#include - -namespace rmm { - -using par_t = decltype(thrust::cuda::par(*(new rmm::mr::thrust_allocator()))); -using deleter_t = std::function; -using exec_policy_t = std::unique_ptr; - -/** - * @brief Returns a unique_ptr to a Thrust CUDA execution policy that uses RMM - * for temporary memory allocation. - * - * @param stream The stream that the allocator will use - * - * @return A Thrust execution policy that will use RMM for temporary memory - * allocation. - */ -[[deprecated("Use new exec_policy in rmm/exec_policy.hpp")]] inline exec_policy_t exec_policy( - cudaStream_t stream = nullptr) -{ - // NOLINTNEXTLINE(cppcoreguidelines-owning-memory) - auto* alloc = new rmm::mr::thrust_allocator(cuda_stream_view{stream}); - auto deleter = [alloc](par_t* pointer) { - delete alloc; // NOLINT(cppcoreguidelines-owning-memory) - delete pointer; // NOLINT(cppcoreguidelines-owning-memory) - }; - - exec_policy_t policy{new par_t(*alloc), deleter}; - return policy; -} - -} // namespace rmm From 6c79958911593475fb1618d66030a3c6ec5bf56e Mon Sep 17 00:00:00 2001 From: Mark Harris Date: Tue, 16 Apr 2024 04:14:06 +0000 Subject: [PATCH 02/15] Remove deprecated detail alignment funcs --- include/rmm/detail/aligned.hpp | 81 ---------------------------------- 1 file changed, 81 deletions(-) diff --git a/include/rmm/detail/aligned.hpp b/include/rmm/detail/aligned.hpp index eb31658e9..1206a1983 100644 --- a/include/rmm/detail/aligned.hpp +++ b/include/rmm/detail/aligned.hpp @@ -26,87 +26,6 @@ namespace rmm::detail { -/** - * @brief Default alignment used for host memory allocated by RMM. - * - */ -[[deprecated("Use rmm::RMM_DEFAULT_HOST_ALIGNMENT instead.")]] static constexpr std::size_t - RMM_DEFAULT_HOST_ALIGNMENT{rmm::RMM_DEFAULT_HOST_ALIGNMENT}; - -/** - * @brief Default alignment used for CUDA memory allocation. - * - */ -[[deprecated("Use rmm::CUDA_ALLOCATION_ALIGNMENT instead.")]] static constexpr std::size_t - CUDA_ALLOCATION_ALIGNMENT{rmm::CUDA_ALLOCATION_ALIGNMENT}; - -/** - * @brief Returns whether or not `n` is a power of 2. - * - */ -[[deprecated("Use rmm::is_pow2 instead.")]] constexpr bool is_pow2(std::size_t value) noexcept -{ - return rmm::is_pow2(value); -} - -/** - * @brief Returns whether or not `alignment` is a valid memory alignment. - * - */ -[[deprecated("Use rmm::is_supported_alignment instead.")]] constexpr bool is_supported_alignment( - std::size_t alignment) noexcept -{ - return rmm::is_pow2(alignment); -} - -/** - * @brief Align up to nearest multiple of specified power of 2 - * - * @param[in] value value to align - * @param[in] alignment amount, in bytes, must be a power of 2 - * - * @return Return the aligned value, as one would expect - */ -[[deprecated("Use rmm::align_up instead.")]] constexpr std::size_t align_up( - std::size_t value, std::size_t alignment) noexcept -{ - return rmm::align_up(value, alignment); -} - -/** - * @brief Align down to the nearest multiple of specified power of 2 - * - * @param[in] value value to align - * @param[in] alignment amount, in bytes, must be a power of 2 - * - * @return Return the aligned value, as one would expect - */ -[[deprecated("Use rmm::align_down instead.")]] constexpr std::size_t align_down( - std::size_t value, std::size_t alignment) noexcept -{ - return rmm::align_down(value, alignment); -} - -/** - * @brief Checks whether a value is aligned to a multiple of a specified power of 2 - * - * @param[in] value value to check for alignment - * @param[in] alignment amount, in bytes, must be a power of 2 - * - * @return true if aligned - */ -[[deprecated("Use rmm::is_aligned instead.")]] constexpr bool is_aligned( - std::size_t value, std::size_t alignment) noexcept -{ - return rmm::is_aligned(value, alignment); -} - -[[deprecated("Use rmm::is_pointer_aligned instead.")]] inline bool is_pointer_aligned( - void* ptr, std::size_t alignment = rmm::CUDA_ALLOCATION_ALIGNMENT) -{ - return rmm::is_pointer_aligned(ptr, alignment); -} - /** * @brief Allocates sufficient host-accessible memory to satisfy the requested size `bytes` with * alignment `alignment` using the unary callable `alloc` to allocate memory. From 9e657b487b10662596b7b080a9cbb62d7c65894e Mon Sep 17 00:00:00 2001 From: Mark Harris Date: Tue, 16 Apr 2024 04:23:17 +0000 Subject: [PATCH 03/15] Remove deprecated ctors from pool_mr --- .../rmm/mr/device/pool_memory_resource.hpp | 170 ------------------ 1 file changed, 170 deletions(-) diff --git a/include/rmm/mr/device/pool_memory_resource.hpp b/include/rmm/mr/device/pool_memory_resource.hpp index 4cbdeef4a..5c0b9a29f 100644 --- a/include/rmm/mr/device/pool_memory_resource.hpp +++ b/include/rmm/mr/device/pool_memory_resource.hpp @@ -111,147 +111,6 @@ class pool_memory_resource final friend class detail::stream_ordered_memory_resource, detail::coalescing_free_list>; - /** - * @brief Construct a `pool_memory_resource` and allocate the initial device memory - * pool using `upstream_mr`. - * - * @deprecated Use the constructor that takes an explicit initial pool size instead. - * - * @throws rmm::logic_error if `upstream_mr == nullptr` - * @throws rmm::logic_error if `initial_pool_size` is neither the default nor aligned to a - * multiple of pool_memory_resource::allocation_alignment bytes. - * @throws rmm::logic_error if `maximum_pool_size` is neither the default nor aligned to a - * multiple of pool_memory_resource::allocation_alignment bytes. - * - * @param upstream_mr The memory_resource from which to allocate blocks for the pool. - * @param initial_pool_size Minimum size, in bytes, of the initial pool. Defaults to zero. - * @param maximum_pool_size Maximum size, in bytes, that the pool can grow to. Defaults to all - * of the available memory from the upstream resource. - */ - template , - thrust::optional>, - int> = 0> - [[deprecated( - "Must specify initial_pool_size and use std::optional instead of thrust::optional.")]] // - explicit pool_memory_resource(Upstream* upstream_mr, - Optional initial_pool_size, - Optional maximum_pool_size = thrust::nullopt) - : pool_memory_resource( - upstream_mr, initial_pool_size.value_or(0), maximum_pool_size.value_or(std::nullopt)) - { - } - - /** - * @brief Construct a `pool_memory_resource` and allocate the initial device memory - * pool using `upstream_mr`. - * - * @deprecated Use the constructor that takes an explicit initial pool size instead. - * - * @throws rmm::logic_error if `upstream_mr == nullptr` - * @throws rmm::logic_error if `initial_pool_size` is neither the default nor aligned to a - * multiple of pool_memory_resource::allocation_alignment bytes. - * @throws rmm::logic_error if `maximum_pool_size` is neither the default nor aligned to a - * multiple of pool_memory_resource::allocation_alignment bytes. - * - * @param upstream_mr The memory_resource from which to allocate blocks for the pool. - * @param initial_pool_size Minimum size, in bytes, of the initial pool. Defaults to zero. - * @param maximum_pool_size Maximum size, in bytes, that the pool can grow to. Defaults to all - * of the available memory from the upstream resource. - */ - [[deprecated("Must specify initial_pool_size")]] // - explicit pool_memory_resource(Upstream* upstream_mr, - std::optional initial_pool_size = std::nullopt, - std::optional maximum_pool_size = std::nullopt) - : pool_memory_resource(upstream_mr, initial_pool_size.value_or(0), maximum_pool_size) - { - } - - /** - * @brief Construct a `pool_memory_resource` and allocate the initial device memory pool using - * `upstream_mr`. - * - * @deprecated Use the constructor that takes an explicit initial pool size instead. - * - * @throws rmm::logic_error if `upstream_mr == nullptr` - * @throws rmm::logic_error if `initial_pool_size` is neither the default nor aligned to a - * multiple of pool_memory_resource::allocation_alignment bytes. - * @throws rmm::logic_error if `maximum_pool_size` is neither the default nor aligned to a - * multiple of pool_memory_resource::allocation_alignment bytes. - * - * @param upstream_mr The memory_resource from which to allocate blocks for the pool. - * @param initial_pool_size Minimum size, in bytes, of the initial pool. Defaults to zero. - * @param maximum_pool_size Maximum size, in bytes, that the pool can grow to. Defaults to all - * of the available memory from the upstream resource. - */ - template , - thrust::optional>, - int> = 0> - [[deprecated( - "Must specify initial_pool_size and use std::optional instead of thrust::optional.")]] // - explicit pool_memory_resource(Upstream& upstream_mr, - Optional initial_pool_size, - Optional maximum_pool_size = thrust::nullopt) - : pool_memory_resource( - upstream_mr, initial_pool_size.value_or(0), maximum_pool_size.value_or(std::nullopt)) - { - } - - /** - * @brief Construct a `pool_memory_resource` and allocate the initial device memory pool using - * `upstream_mr`. - * - * @deprecated Use the constructor that takes an explicit initial pool size instead. - * - * @throws rmm::logic_error if `upstream_mr == nullptr` - * @throws rmm::logic_error if `initial_pool_size` is neither the default nor aligned to a - * multiple of pool_memory_resource::allocation_alignment bytes. - * @throws rmm::logic_error if `maximum_pool_size` is neither the default nor aligned to a - * multiple of pool_memory_resource::allocation_alignment bytes. - * - * @param upstream_mr The memory_resource from which to allocate blocks for the pool. - * @param initial_pool_size Minimum size, in bytes, of the initial pool. Defaults to zero. - * @param maximum_pool_size Maximum size, in bytes, that the pool can grow to. Defaults to all - * of the available memory from the upstream resource. - */ - template , int> = 0> - [[deprecated("Must specify initial_pool_size")]] // - explicit pool_memory_resource(Upstream2& upstream_mr, - std::optional initial_pool_size = std::nullopt, - std::optional maximum_pool_size = std::nullopt) - : pool_memory_resource(upstream_mr, initial_pool_size.value_or(0), maximum_pool_size) - { - } - - /** - * @brief Construct a `pool_memory_resource` and allocate the initial device memory pool using - * `upstream_mr`. - * - * @throws rmm::logic_error if `upstream_mr == nullptr` - * @throws rmm::logic_error if `initial_pool_size` is not aligned to a multiple of - * pool_memory_resource::allocation_alignment bytes. - * @throws rmm::logic_error if `maximum_pool_size` is neither the default nor aligned to a - * multiple of pool_memory_resource::allocation_alignment bytes. - * - * @param upstream_mr The memory_resource from which to allocate blocks for the pool. - * @param initial_pool_size Minimum size, in bytes, of the initial pool. - * @param maximum_pool_size Maximum size, in bytes, that the pool can grow to. Defaults to all - * of the available from the upstream resource. - */ - template , - thrust::optional>, - int> = 0> - [[deprecated("Use std::optional instead of thrust::optional.")]] // - explicit pool_memory_resource(Upstream* upstream_mr, - std::size_t initial_pool_size, - Optional maximum_pool_size) - : pool_memory_resource(upstream_mr, initial_pool_size, maximum_pool_size.value_or(std::nullopt)) - { - } - /** * @brief Construct a `pool_memory_resource` and allocate the initial device memory pool using * `upstream_mr`. @@ -283,35 +142,6 @@ class pool_memory_resource final initialize_pool(initial_pool_size, maximum_pool_size); } - /** - * @brief Construct a `pool_memory_resource` and allocate the initial device memory pool using - * `upstream_mr`. - * - * @throws rmm::logic_error if `upstream_mr == nullptr` - * @throws rmm::logic_error if `initial_pool_size` is not aligned to a multiple of - * pool_memory_resource::allocation_alignment bytes. - * @throws rmm::logic_error if `maximum_pool_size` is neither the default nor aligned to a - * multiple of pool_memory_resource::allocation_alignment bytes. - * - * @param upstream_mr The memory_resource from which to allocate blocks for the pool. - * @param initial_pool_size Minimum size, in bytes, of the initial pool. - * @param maximum_pool_size Maximum size, in bytes, that the pool can grow to. Defaults to all - * of the available memory from the upstream resource. - */ - template , - thrust::optional>, - int> = 0> - [[deprecated("Use std::optional instead of thrust::optional.")]] // - explicit pool_memory_resource(Upstream& upstream_mr, - std::size_t initial_pool_size, - Optional maximum_pool_size) - : pool_memory_resource(cuda::std::addressof(upstream_mr), - initial_pool_size, - maximum_pool_size.value_or(std::nullopt)) - { - } - /** * @brief Construct a `pool_memory_resource` and allocate the initial device memory pool using * `upstream_mr`. From d81f46498e32af1cc173d09bda04d11e3beb22ba Mon Sep 17 00:00:00 2001 From: Mark Harris Date: Tue, 23 Apr 2024 05:17:21 +0000 Subject: [PATCH 04/15] Remove deprecated constructor from cuda_async_memory_resource --- .../mr/device/cuda_async_memory_resource.hpp | 34 ------------------- 1 file changed, 34 deletions(-) diff --git a/include/rmm/mr/device/cuda_async_memory_resource.hpp b/include/rmm/mr/device/cuda_async_memory_resource.hpp index ac6b72076..871aaaaed 100644 --- a/include/rmm/mr/device/cuda_async_memory_resource.hpp +++ b/include/rmm/mr/device/cuda_async_memory_resource.hpp @@ -68,40 +68,6 @@ class cuda_async_memory_resource final : public device_memory_resource { win32_kmt = 0x4 ///< Allows a Win32 KMT handle to be used for exporting. (D3DKMT_HANDLE) }; - /** - * @brief Constructs a cuda_async_memory_resource with the optionally specified initial pool size - * and release threshold. - * - * If the pool size grows beyond the release threshold, unused memory held by the pool will be - * released at the next synchronization event. - * - * @throws rmm::logic_error if the CUDA version does not support `cudaMallocAsync` - * - * @param initial_pool_size Optional initial size in bytes of the pool. If no value is provided, - * initial pool size is half of the available GPU memory. - * @param release_threshold Optional release threshold size in bytes of the pool. If no value is - * provided, the release threshold is set to the total amount of memory on the current device. - * @param export_handle_type Optional `cudaMemAllocationHandleType` that allocations from this - * resource should support interprocess communication (IPC). Default is - * `cudaMemHandleTypeNone` for no IPC support. - */ - // NOLINTNEXTLINE(bugprone-easily-swappable-parameters) - template , - thrust::optional>, - int> = 0> - [[deprecated("Use std::optional instead of thrust::optional.")]] // - explicit cuda_async_memory_resource( - Optional initial_pool_size, - Optional release_threshold = {}, - thrust::optional export_handle_type = {}) - : cuda_async_memory_resource(initial_pool_size.value_or(std::nullopt), - release_threshold.value_or(std::nullopt), - export_handle_type.value_or(std::nullopt)) - - { - } - /** * @brief Constructs a cuda_async_memory_resource with the optionally specified initial pool size * and release threshold. From 1b60b95b3356b09c0cd6361e696c89e7ff615d36 Mon Sep 17 00:00:00 2001 From: Mark Harris Date: Tue, 23 Apr 2024 20:33:23 +0000 Subject: [PATCH 05/15] Remove deleted file from conda recipe tests --- conda/recipes/librmm/meta.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/conda/recipes/librmm/meta.yaml b/conda/recipes/librmm/meta.yaml index 8263e0f3d..0d3bd0add 100644 --- a/conda/recipes/librmm/meta.yaml +++ b/conda/recipes/librmm/meta.yaml @@ -81,7 +81,6 @@ outputs: - spdlog {{ spdlog_version }} test: commands: - - test -f $PREFIX/include/rmm/thrust_rmm_allocator.h - test -f $PREFIX/include/rmm/logger.hpp - test -f $PREFIX/include/rmm/cuda_stream.hpp - test -f $PREFIX/include/rmm/cuda_stream_view.hpp From 2cf999785386b6d78de293e89c115af080822e39 Mon Sep 17 00:00:00 2001 From: Mark Harris Date: Tue, 23 Apr 2024 23:39:28 +0000 Subject: [PATCH 06/15] Comment out deprecated docs section while there are no deprecated items. --- .../docs/librmm_docs/{deprecated.rst => deprecated.rst.bak} | 0 python/rmm/docs/librmm_docs/index.rst | 4 +++- 2 files changed, 3 insertions(+), 1 deletion(-) rename python/rmm/docs/librmm_docs/{deprecated.rst => deprecated.rst.bak} (100%) diff --git a/python/rmm/docs/librmm_docs/deprecated.rst b/python/rmm/docs/librmm_docs/deprecated.rst.bak similarity index 100% rename from python/rmm/docs/librmm_docs/deprecated.rst rename to python/rmm/docs/librmm_docs/deprecated.rst.bak diff --git a/python/rmm/docs/librmm_docs/index.rst b/python/rmm/docs/librmm_docs/index.rst index 2b61deb9f..69fb2ccd0 100644 --- a/python/rmm/docs/librmm_docs/index.rst +++ b/python/rmm/docs/librmm_docs/index.rst @@ -18,7 +18,9 @@ librmm Documentation errors logging utilities - deprecated +.. Rename deprecated.rst.bak to deprecated.rst and uncomment the +.. following if there are any [[deprecated]] C++ APIs +.. deprecated .. doxygennamespace:: rmm From 1dbb39a1ac1a2ab6ff2ba8e4c5f097c680debbe4 Mon Sep 17 00:00:00 2001 From: Mark Harris Date: Wed, 24 Apr 2024 00:17:49 +0000 Subject: [PATCH 07/15] Style --- python/rmm/docs/librmm_docs/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/python/rmm/docs/librmm_docs/index.rst b/python/rmm/docs/librmm_docs/index.rst index 69fb2ccd0..8e64d916e 100644 --- a/python/rmm/docs/librmm_docs/index.rst +++ b/python/rmm/docs/librmm_docs/index.rst @@ -18,9 +18,9 @@ librmm Documentation errors logging utilities -.. Rename deprecated.rst.bak to deprecated.rst and uncomment the +.. Rename deprecated.rst.bak to deprecated.rst and uncomment the .. following if there are any [[deprecated]] C++ APIs -.. deprecated +.. deprecated .. doxygennamespace:: rmm From 68a7a02d18aa14a627a445ea75ec1f26d5605f62 Mon Sep 17 00:00:00 2001 From: Mark Harris Date: Wed, 24 Apr 2024 01:55:33 +0000 Subject: [PATCH 08/15] Revert previous docs change. --- .../docs/librmm_docs/{deprecated.rst.bak => deprecated.rst} | 0 python/rmm/docs/librmm_docs/index.rst | 5 +---- 2 files changed, 1 insertion(+), 4 deletions(-) rename python/rmm/docs/librmm_docs/{deprecated.rst.bak => deprecated.rst} (100%) diff --git a/python/rmm/docs/librmm_docs/deprecated.rst.bak b/python/rmm/docs/librmm_docs/deprecated.rst similarity index 100% rename from python/rmm/docs/librmm_docs/deprecated.rst.bak rename to python/rmm/docs/librmm_docs/deprecated.rst diff --git a/python/rmm/docs/librmm_docs/index.rst b/python/rmm/docs/librmm_docs/index.rst index 8e64d916e..5094455f1 100644 --- a/python/rmm/docs/librmm_docs/index.rst +++ b/python/rmm/docs/librmm_docs/index.rst @@ -18,10 +18,7 @@ librmm Documentation errors logging utilities -.. Rename deprecated.rst.bak to deprecated.rst and uncomment the -.. following if there are any [[deprecated]] C++ APIs -.. deprecated - + deprecated .. doxygennamespace:: rmm :desc-only: From 92378152875610b0459ee2a37f85605667103d13 Mon Sep 17 00:00:00 2001 From: Mark Harris Date: Wed, 24 Apr 2024 01:55:50 +0000 Subject: [PATCH 09/15] Use conf.py to exclude deprecated page if it doesn't exist. --- python/rmm/docs/conf.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/python/rmm/docs/conf.py b/python/rmm/docs/conf.py index 0140c84b2..7cf1fdfdb 100644 --- a/python/rmm/docs/conf.py +++ b/python/rmm/docs/conf.py @@ -89,6 +89,16 @@ # This patterns also effect to html_static_path and html_extra_path exclude_patterns = [] +# List of warnings to suppress +suppress_warnings = [] + +# if the file deprecated.xml does not exist in the doxygen xml output, breathe +# will fail to build the docs, so we conditionally add "breathe.rst" to the +# exclude_patterns list +if not os.path.exists(breathe_projects["librmm"] + "/deprecated.xml"): + exclude_patterns.append("librmm_docs/deprecated.rst") + suppress_warnings = ['toc.excluded'] + # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" From f9b11ea0e9b0ce3ef98a09da6fef40c37685c736 Mon Sep 17 00:00:00 2001 From: Mark Harris Date: Wed, 24 Apr 2024 01:56:28 +0000 Subject: [PATCH 10/15] style --- python/rmm/docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python/rmm/docs/conf.py b/python/rmm/docs/conf.py index 7cf1fdfdb..d2886fec4 100644 --- a/python/rmm/docs/conf.py +++ b/python/rmm/docs/conf.py @@ -97,7 +97,7 @@ # exclude_patterns list if not os.path.exists(breathe_projects["librmm"] + "/deprecated.xml"): exclude_patterns.append("librmm_docs/deprecated.rst") - suppress_warnings = ['toc.excluded'] + suppress_warnings = ["toc.excluded"] # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" From 473460736ad561097fd5d38ca784e1870438be44 Mon Sep 17 00:00:00 2001 From: Mark Harris Date: Wed, 24 Apr 2024 01:59:17 +0000 Subject: [PATCH 11/15] Use append --- python/rmm/docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python/rmm/docs/conf.py b/python/rmm/docs/conf.py index d2886fec4..9f08d49bd 100644 --- a/python/rmm/docs/conf.py +++ b/python/rmm/docs/conf.py @@ -97,7 +97,7 @@ # exclude_patterns list if not os.path.exists(breathe_projects["librmm"] + "/deprecated.xml"): exclude_patterns.append("librmm_docs/deprecated.rst") - suppress_warnings = ["toc.excluded"] + suppress_warnings.append("toc.excluded") # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" From a8dfafb75ce38defb85776ddaefdc263869d0258 Mon Sep 17 00:00:00 2001 From: Mark Harris Date: Wed, 24 Apr 2024 02:00:57 +0000 Subject: [PATCH 12/15] Add back removed blank line --- python/rmm/docs/librmm_docs/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/python/rmm/docs/librmm_docs/index.rst b/python/rmm/docs/librmm_docs/index.rst index 5094455f1..2b61deb9f 100644 --- a/python/rmm/docs/librmm_docs/index.rst +++ b/python/rmm/docs/librmm_docs/index.rst @@ -20,6 +20,7 @@ librmm Documentation utilities deprecated + .. doxygennamespace:: rmm :desc-only: From a833222d61537a28078efc43ecbf70bf3c29d705 Mon Sep 17 00:00:00 2001 From: Mark Harris <783069+harrism@users.noreply.github.com> Date: Thu, 25 Apr 2024 07:20:10 +1000 Subject: [PATCH 13/15] doc copilot-o Co-authored-by: Vyas Ramasubramani --- python/rmm/docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python/rmm/docs/conf.py b/python/rmm/docs/conf.py index 9f08d49bd..a391be24f 100644 --- a/python/rmm/docs/conf.py +++ b/python/rmm/docs/conf.py @@ -93,7 +93,7 @@ suppress_warnings = [] # if the file deprecated.xml does not exist in the doxygen xml output, breathe -# will fail to build the docs, so we conditionally add "breathe.rst" to the +# will fail to build the docs, so we conditionally add "deprecated.rst" to the # exclude_patterns list if not os.path.exists(breathe_projects["librmm"] + "/deprecated.xml"): exclude_patterns.append("librmm_docs/deprecated.rst") From f5cb0b721f848de2c5616e3b73d92081bc39262b Mon Sep 17 00:00:00 2001 From: Mark Harris <783069+harrism@users.noreply.github.com> Date: Thu, 25 Apr 2024 07:20:31 +1000 Subject: [PATCH 14/15] os.path.join Co-authored-by: Vyas Ramasubramani --- python/rmm/docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python/rmm/docs/conf.py b/python/rmm/docs/conf.py index a391be24f..2ef13ff9b 100644 --- a/python/rmm/docs/conf.py +++ b/python/rmm/docs/conf.py @@ -95,7 +95,7 @@ # if the file deprecated.xml does not exist in the doxygen xml output, breathe # will fail to build the docs, so we conditionally add "deprecated.rst" to the # exclude_patterns list -if not os.path.exists(breathe_projects["librmm"] + "/deprecated.xml"): +if not os.path.exists(os.path.join(breathe_projects["librmm"], "deprecated.xml")): exclude_patterns.append("librmm_docs/deprecated.rst") suppress_warnings.append("toc.excluded") From 73a3ecbe61ee445ec7013fa2076ba4077ccae0de Mon Sep 17 00:00:00 2001 From: Mark Harris Date: Mon, 29 Apr 2024 23:34:35 +0000 Subject: [PATCH 15/15] style --- python/rmm/docs/conf.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/python/rmm/docs/conf.py b/python/rmm/docs/conf.py index 2ef13ff9b..6ed770151 100644 --- a/python/rmm/docs/conf.py +++ b/python/rmm/docs/conf.py @@ -92,10 +92,12 @@ # List of warnings to suppress suppress_warnings = [] -# if the file deprecated.xml does not exist in the doxygen xml output, breathe -# will fail to build the docs, so we conditionally add "deprecated.rst" to the -# exclude_patterns list -if not os.path.exists(os.path.join(breathe_projects["librmm"], "deprecated.xml")): +# if the file deprecated.xml does not exist in the doxygen xml output, +# breathe will fail to build the docs, so we conditionally add +# "deprecated.rst" to the exclude_patterns list +if not os.path.exists( + os.path.join(breathe_projects["librmm"], "deprecated.xml") +): exclude_patterns.append("librmm_docs/deprecated.rst") suppress_warnings.append("toc.excluded")