{{ docstitle }}
-{{ docstitle }}
- diff --git a/docs/source/conf.py b/docs/source/conf.py index cbb7ef2323..f1926e26ee 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: Copyright (c) 2018-2026, NVIDIA CORPORATION. +# SPDX-FileCopyrightText: Copyright (c) 2018-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. # SPDX-License-Identifier: Apache-2.0 import datetime @@ -64,7 +64,7 @@ master_doc = "index" # General information about the project. -project = "RAFT" +project = "NVIDIA RAFT" copyright = f"2023-{datetime.datetime.today().year}, NVIDIA Corporation" author = "NVIDIA Corporation" @@ -105,8 +105,6 @@ # html_theme = "nvidia_sphinx_theme" -html_logo = "../../img/logo-purple-bg-white-text.svg" -html_favicon = "../../img/icon-512x512.png" # Theme options are theme-specific and customize the look and feel of a theme @@ -115,10 +113,14 @@ # html_theme_options = { "external_links": [], - # https://github.com/pydata/pydata-sphinx-theme/issues/1220 - "icon_links": [], - "github_url": "https://github.com/rapidsai/raft", - "twitter_url": "https://twitter.com/rapidsai", + "icon_links": [ + { + "name": "GitHub", + "url": "https://github.com/NVIDIA/raft", + "icon": "fa-brands fa-github", + "type": "fontawesome", + }, + ], "show_toc_level": 1, "navbar_align": "right", } @@ -159,7 +161,7 @@ ( master_doc, "raft.tex", - "RAFT Documentation", + f"{project} Documentation", "NVIDIA Corporation", "manual", ), @@ -169,7 +171,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [(master_doc, "raft", "RAFT Documentation", [author], 1)] +man_pages = [(master_doc, "raft", f"{project} Documentation", [author], 1)] # -- Options for Texinfo output ------------------------------------------- @@ -180,7 +182,7 @@ ( master_doc, "raft", - "RAFT Documentation", + f"{project} Documentation", author, "raft", "One line description of project.", @@ -201,17 +203,13 @@ def setup(app): app.add_css_file("references.css") - app.add_css_file("https://docs.rapids.ai/assets/css/custom.css") - app.add_js_file( - "https://docs.rapids.ai/assets/js/custom.js", loading_method="defer" - ) app.add_js_file("collapse_overloads.js") # The following is used by sphinx.ext.linkcode to provide links to github linkcode_resolve = make_linkcode_resolve( "pylibraft", - "https://github.com/rapidsai/raft" + "https://github.com/NVIDIA/raft" "/blob/{revision}/python/pylibraft/" "{package}/{path}#L{lineno}", ) diff --git a/docs/source/contributing.md b/docs/source/contributing.md index 446e7b2a7b..3cba7f6678 100755 --- a/docs/source/contributing.md +++ b/docs/source/contributing.md @@ -23,7 +23,7 @@ into three categories: ### Your first issue -1. Read the project's [README.md](https://github.com/rapidsai/raft) +1. Read the project's [README.md](https://github.com/NVIDIA/raft) to learn how to setup the development environment 2. Find an issue to work on. The best way is to look for the [good first issue](https://github.com/rapidsai/RAFT/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or [help wanted](https://github.com/rapidsai/RAFT/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) labels diff --git a/docs/source/developer_guide.md b/docs/source/developer_guide.md index cd1e426707..ae646ce901 100644 --- a/docs/source/developer_guide.md +++ b/docs/source/developer_guide.md @@ -187,7 +187,7 @@ RAFT relies on `clang-format` to enforce code style across all C++ and CUDA sour 1. Do not split empty functions/records/namespaces. 2. Two-space indentation everywhere, including the line continuations. 3. Disable reflowing of comments. - The reasons behind these deviations from the Google style guide are given in comments [here](https://github.com/rapidsai/raft/blob/main/cpp/.clang-format). + The reasons behind these deviations from the Google style guide are given in comments [here](https://github.com/NVIDIA/raft/blob/main/cpp/.clang-format). [`doxygen`](https://doxygen.nl/) is used as documentation generator and also as a documentation linter. In order to run doxygen as a linter on C++/CUDA code, run @@ -205,7 +205,7 @@ you can run `codespell -i 3 -w .` from the repository root directory. This will bring up an interactive prompt to select which spelling fixes to apply. ### #include style -[include_checker.py](https://github.com/rapidsai/raft/blob/main/cpp/scripts/include_checker.py) is used to enforce the include style as follows: +[include_checker.py](https://github.com/NVIDIA/raft/blob/main/cpp/scripts/include_checker.py) is used to enforce the include style as follows: 1. `#include "..."` should be used for referencing local files only. It is acceptable to be used for referencing files in a sub-folder/parent-folder of the same algorithm, but should never be used to include files in other algorithms or between algorithms and the primitives or other dependencies. 2. `#include <...>` should be used for referencing everything else @@ -230,7 +230,7 @@ Call CUDA APIs via the provided helper macros `RAFT_CUDA_TRY`, `RAFT_CUBLAS_TRY` ## Logging ### Introduction -Anything and everything about logging is defined inside [logger.hpp](https://github.com/rapidsai/raft/blob/main/cpp/include/raft/core/logger.hpp). RAFT logging is built on top of [rapids-logger](https://github.com/rapidsai/rapids-logger) (which wraps [spdlog](https://github.com/gabime/spdlog) underneath), but this information is transparent to all. The global logger is obtained via `raft::default_logger()`. +Anything and everything about logging is defined inside [logger.hpp](https://github.com/NVIDIA/raft/blob/main/cpp/include/raft/core/logger.hpp). RAFT logging is built on top of [rapids-logger](https://github.com/rapidsai/rapids-logger) (which wraps [spdlog](https://github.com/gabime/spdlog) underneath), but this information is transparent to all. The global logger is obtained via `raft::default_logger()`. ### Usage ```cpp @@ -396,7 +396,7 @@ template void raft::expensive