Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct basics to api cross refs #405

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
API Reference
#############

.. _`common`:

Common
******
Expand All @@ -19,6 +20,8 @@ require.
/command/rapids_cmake_write_git_revision_file
/command/rapids_cmake_write_version_file

.. _`cpm`:

CPM
***

Expand Down Expand Up @@ -56,6 +59,8 @@ package uses :ref:`can be found here. <cpm_versions>`
/packages/rapids_cpm_thrust
/command/rapids_cpm_package_override

.. _`cython`:

Cython
******

Expand All @@ -74,6 +79,8 @@ The `rapids_cython` functions allow projects to easily build cython modules usin
/command/rapids_cython_add_rpath_entries


.. _`find`:

Find
****

Expand All @@ -86,6 +93,8 @@ tracking of these dependencies for correct export support.
/command/rapids_find_generate_module
/command/rapids_find_package

.. _`cuda`:

CUDA
****

Expand All @@ -101,6 +110,8 @@ require.
rapids_cuda_set_architectures [Advanced] </command/rapids_cuda_set_architectures>


.. _`export`:

Export Set Generation
*********************

Expand Down Expand Up @@ -134,6 +145,8 @@ correct export generation. These should only be used when :cmake:command:`rapids
rapids_export_find_package_root [Advanced] </command/rapids_export_find_package_root>
rapids_export_package [Advanced] </command/rapids_export_package>

.. _`testing`:

Testing
*******

Expand Down
2 changes: 2 additions & 0 deletions docs/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,11 @@ 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>`__

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

Expand Down