Skip to content

Commit

Permalink
Fix docs references to API sections. (#509)
Browse files Browse the repository at this point in the history
The links in this section are broken: https://docs.rapids.ai/api/rapids-cmake/stable/basics/#usage

This PR fixes them. We have to use `:ref:` instead of raw HTML links because the HTML structure is different on the public docs website. (like `/api/` instead of `api.html`).

Authors:
  - Bradley Dice (https://github.com/bdice)

Approvers:
  - Robert Maynard (https://github.com/robertmaynard)

URL: #509
  • Loading branch information
bdice authored Dec 18, 2023
1 parent 7d2b702 commit d887815
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 10 deletions.
2 changes: 2 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ tracking of these dependencies for correct export support.
/command/rapids_cpm_find
/command/rapids_cpm_package_override

.. _`cpm_pre-configured_packages`:

CPM Pre-Configured Packages
***************************

Expand Down
14 changes: 7 additions & 7 deletions docs/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ Usage
``rapids-cmake`` is designed for projects to use only the subset of features that they need. To enable
this `rapids-cmake` comprises the following primary components:

- `cmake <api.html#common>`__
- `cpm <api.html#cpm>`__
- `cython <api.html#cython>`__
- `cuda <api.html#cuda>`__
- `export <api.html#export>`__
- `find <api.html#find>`__
- `testing <api.html#testing>`__
- :ref:`cmake <common>`
- :ref:`cpm <cpm>`
- :ref:`cython <cython>`
- :ref:`cuda <cuda>`
- :ref:`export <export>`
- :ref:`find <find>`
- :ref:`testing <testing>`

There are two ways projects can use ``rapids-cmake`` functions.

Expand Down
2 changes: 1 addition & 1 deletion rapids-cmake/cpm/find.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Overriding
^^^^^^^^^^
The :cmake:command:`rapids_cpm_package_override` command provides a way
for projects to override the default values for any :cmake:command:`rapids_cpm_find`, `rapids_cpm_* <../api.html#cpm-pre-configured-packages>`__,
for projects to override the default values for any :cmake:command:`rapids_cpm_find`, :ref:`rapids_cpm_* <cpm_pre-configured_packages>`,
`CPM <https://github.com/cpm-cmake/CPM.cmake>`_, and :cmake:module:`FetchContent() <cmake:module:FetchContent>` package.
By default when an override for a project is provided no local search
Expand Down
4 changes: 2 additions & 2 deletions rapids-cmake/cpm/package_override.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ rapids_cpm_package_override
.. versionadded:: v21.10.00
Overrides the :cmake:command:`rapids_cpm_find`, `rapids_cpm_* <../api.html#cpm-pre-configured-packages>`__,
Overrides the :cmake:command:`rapids_cpm_find`, :ref:`rapids_cpm_* <cpm_pre-configured_packages>`,
`CPM <https://github.com/cpm-cmake/CPM.cmake>`_, and :cmake:module:`FetchContent() <cmake:module:FetchContent>` package information for the project.
.. code-block:: cmake
rapids_cpm_package_override(<json_file_path>)
Allows projects to override the default values for any :cmake:command:`rapids_cpm_find`,
`rapids_cpm_* <../api.html#cpm-pre-configured-packages>`__, `CPM <https://github.com/cpm-cmake/CPM.cmake>`_, and :cmake:module:`FetchContent() <cmake:module:FetchContent>` package.
:ref:`rapids_cpm_* <cpm_pre-configured_packages>`, `CPM <https://github.com/cpm-cmake/CPM.cmake>`_, and :cmake:module:`FetchContent() <cmake:module:FetchContent>` package.
The user provided json file must follow the `versions.json` format,
which is :ref:`documented here<cpm_version_format>` and shown in the below
Expand Down

0 comments on commit d887815

Please sign in to comment.