example docs

kokkos · Dec 19, 2023 · 19ba79f · 19ba79f
1 parent b88a24a
commit 19ba79f
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -14,6 +14,8 @@ ctest
 
 [cwpearson.github.io/kokkos-comm/](https://cwpearson.github.io/kokkos-comm/)
 
+https://www.sphinx-doc.org/en/master/usage/domains/cpp.html
+
 ## Design
 
 - [x] use `Kokkos::deep_copy` to handle packing and unpacking of non-contiguous views

diff --git a/docs/api/collective.rst b/docs/api/collective.rst
@@ -0,0 +1,2 @@
+Collective Communication
+========================
diff --git a/docs/api/p2p.rst b/docs/api/p2p.rst
@@ -0,0 +1,15 @@
+Point-to-point
+==============
+
+.. cpp:function:: template <typename SendView, typename ExecSpace> \
+                  void Kokkos::send(const ExecSpace &space, const SendView &sv, int dest, int tag, MPI_Comm comm)
+
+    MPI_Send wrapper.
+
+    :param space: The execution space to operate in
+    :param sv: The data to send
+    :param dest: the destination rank
+    :param tag: the MPI tag
+    :param comm: the MPI communicator
+    :tparam SendView: A Kokkos::View to send
+    :tparam ExecSpace: A Kokkos execution space to operate in
diff --git a/docs/api/traits.rst b/docs/api/traits.rst
@@ -0,0 +1,6 @@
+Traits
+======
+
+.. cpp:type:: KokkosComm::Traits
+
+    Blah blah
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,13 +3,25 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to KokkosComm's documentation!
+KokkosComm documentation!
 ======================================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
+   api/traits
+   api/p2p
+   api/collective
+
+Usage
+-----
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   usage/getting_started
 
 
 Indices and tables

diff --git a/docs/usage/getting_started.rst b/docs/usage/getting_started.rst
@@ -0,0 +1,2 @@
+Getting Started
+===============
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Collective Communication
		========================