Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
Signed-off-by: Chen Wang <[email protected]>
  • Loading branch information
wangvsa committed Jan 4, 2025
1 parent 5d56d10 commit 45656d5
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 11 deletions.
8 changes: 3 additions & 5 deletions docs/source/build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ kernels.
add ``-DRECORDER_ENABLE_PARQUET=ON`` to cmake to build the Parquet
format converter

<!--
2. Building Recorder with Spack

Building Recorder with Spack
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

.. code:: bash
spack install recorder
spack install recorder

By default Recorder generates traces from all levels, you can use **~**
to disable a specific level.
Expand All @@ -86,4 +85,3 @@ tracing disabled.
.. code:: bash
spack install recorder~hdf5~mpi
-->
7 changes: 3 additions & 4 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
|build|

Overview
========

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

.. toctree::
:maxdepth: 1
:hidden

quickstart
build
usage
features
postprocessing
changes

.. |build| image:: https://github.com/uiuc-hpc/Recorder/actions/workflows/cmake.yml/badge.svg
:target: https://github.com/uiuc-hpc/Recorder/actions/workflows/cmake.yml

2 changes: 0 additions & 2 deletions docs/source/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
|build|

Recorder
========

Expand Down

0 comments on commit 45656d5

Please sign in to comment.