Skip to content

Commit 6518456

Browse files
committed
Re-introduce example documentation. This needs completing prior to merge
1 parent ea57db1 commit 6518456

3 files changed

Lines changed: 18 additions & 1 deletion

File tree

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Boids Brute Force
2+
=================
3+

src/example-docs/index.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Example Documentation
2+
=====================
3+
4+
The example documentation provides clear explanations of each of the example projects.
5+
6+
7+
.. toctree::
8+
:maxdepth: 5
9+
:caption: Examples:
10+
11+
1-boids-bruteforce.rst
12+

src/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ Welcome to FLAME GPU 2's documentation!
1010
:maxdepth: 5
1111
:caption: Contents:
1212

13-
guide/index.rst
13+
guide/index.rst
14+
example-docs/index.rst
15+
1416
api/library_root
1517

1618

0 commit comments

Comments
 (0)