From 7f2e35f55cc9ffdc8d80653110e30c9ca717219f Mon Sep 17 00:00:00 2001 From: Vyas Ramasubramani Date: Thu, 21 Sep 2023 10:54:17 -0700 Subject: [PATCH] First pass of reorg --- python/docs/cpp.rst | 8 ++++++++ python/docs/{librmm_api.rst => cpp_api.rst} | 2 +- python/docs/{basics.md => guide.md} | 2 +- python/docs/index.rst | 5 ++--- python/docs/python.rst | 9 +++++++++ python/docs/{api.rst => python_api.rst} | 0 6 files changed, 21 insertions(+), 5 deletions(-) create mode 100644 python/docs/cpp.rst rename python/docs/{librmm_api.rst => cpp_api.rst} (73%) rename python/docs/{basics.md => guide.md} (99%) create mode 100644 python/docs/python.rst rename python/docs/{api.rst => python_api.rst} (100%) diff --git a/python/docs/cpp.rst b/python/docs/cpp.rst new file mode 100644 index 000000000..e60f15129 --- /dev/null +++ b/python/docs/cpp.rst @@ -0,0 +1,8 @@ +Welcome to the rmm C++ documentation! +======================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + cpp_api.rst diff --git a/python/docs/librmm_api.rst b/python/docs/cpp_api.rst similarity index 73% rename from python/docs/librmm_api.rst rename to python/docs/cpp_api.rst index 087eda247..ca0afbb0d 100644 --- a/python/docs/librmm_api.rst +++ b/python/docs/cpp_api.rst @@ -1,4 +1,4 @@ API Reference -============== +============= .. doxygennamespace:: rmm diff --git a/python/docs/basics.md b/python/docs/guide.md similarity index 99% rename from python/docs/basics.md rename to python/docs/guide.md index 997745f00..c06135ca8 100644 --- a/python/docs/basics.md +++ b/python/docs/guide.md @@ -1,4 +1,4 @@ -# RMM - the RAPIDS Memory Manager +# User Guide Achieving optimal performance in GPU-centric workflows frequently requires customizing how GPU ("device") memory is allocated. diff --git a/python/docs/index.rst b/python/docs/index.rst index 4a675d297..524351253 100644 --- a/python/docs/index.rst +++ b/python/docs/index.rst @@ -10,9 +10,8 @@ Welcome to rmm's documentation! :maxdepth: 2 :caption: Contents: - basics.md - api.rst - librmm_api.rst + Python + C++ Indices and tables diff --git a/python/docs/python.rst b/python/docs/python.rst new file mode 100644 index 000000000..bff919627 --- /dev/null +++ b/python/docs/python.rst @@ -0,0 +1,9 @@ +Welcome to the rmm Python documentation! +======================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + guide.md + python_api.rst diff --git a/python/docs/api.rst b/python/docs/python_api.rst similarity index 100% rename from python/docs/api.rst rename to python/docs/python_api.rst