Skip to content

Commit 45656d5

Browse files
committed
Update doc
Signed-off-by: Chen Wang <[email protected]>
1 parent 5d56d10 commit 45656d5

File tree

3 files changed

+6
-11
lines changed

3 files changed

+6
-11
lines changed

docs/source/build.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ kernels.
6363
add ``-DRECORDER_ENABLE_PARQUET=ON`` to cmake to build the Parquet
6464
format converter
6565

66-
<!--
67-
2. Building Recorder with Spack
66+
67+
Building Recorder with Spack
6868
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6969

7070
*NOTE: please do not use Spack to install Recorder for now. The version
@@ -74,8 +74,7 @@ For now, building Recorder with Spack provides less flexibility. We will
7474
add the CMake options for spack as well.
7575

7676
.. code:: bash
77-
78-
spack install recorder
77+
spack install recorder
7978

8079
By default Recorder generates traces from all levels, you can use **~**
8180
to disable a specific level.
@@ -86,4 +85,3 @@ tracing disabled.
8685
.. code:: bash
8786
8887
spack install recorder~hdf5~mpi
89-
-->

docs/source/index.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
|build|
2+
13
Overview
24
========
35

@@ -51,15 +53,12 @@ Symposium on High-Performance Parallel and Distributed Computing (HPDC).
5153

5254
.. toctree::
5355
:maxdepth: 1
54-
:hidden
55-
5656
quickstart
5757
build
5858
usage
5959
features
6060
postprocessing
6161
changes
62-
62+
6363
.. |build| image:: https://github.com/uiuc-hpc/Recorder/actions/workflows/cmake.yml/badge.svg
6464
:target: https://github.com/uiuc-hpc/Recorder/actions/workflows/cmake.yml
65-

docs/source/quickstart.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
|build|
2-
31
Recorder
42
========
53

0 commit comments

Comments
 (0)