Update doc

Signed-off-by: Chen Wang <[email protected]>
uiuc-hpc · Jan 4, 2025 · 82c46b9 · 82c46b9
1 parent 45656d5
commit 82c46b9
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 20 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,4 @@
 sphinx==7.1.2
 sphinx-rtd-theme==1.3.0rc1
 furo
+myst-parser
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -3,8 +3,8 @@
 # -- Project information
 
 project = 'Recorder'
-#copyright = '2021, Graziella'
-#author = 'Graziella'
+#copyright = '2024, Chen Wang'
+#author = 'Chen Wang'
 
 #release = '0.1'
 #version = '0.1.0'
@@ -17,6 +17,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
+    'myst_parser'
 ]
 
 intersphinx_mapping = {

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,16 +3,7 @@
 Overview
 ========
 
-We believe that multi-level I/O tracing and trace data analysis tool can
-help end users understand the behavior of their application and I/O
-subsystem, and can provide insights into the source of I/O performance
-bottlenecks.
-
-Recorder is a multi-level I/O tracing framework that can capture I/O
-function calls at multiple levels of the I/O stack, including HDF5,
-MPI-IO, and POSIX I/O. Recorder requires no modification or
-recompilation of the application and users can control what levels are
-traced.
+Recorder is a multi-level I/O tracing framework that can capture I/O function calls at multiple levels of the I/O stack, including HDF5, PnetCDF, NetCDF, MPI-IO, and POSIX I/O. Recorder requires no modification or recompilation of the application and users can control what levels are traced.
 
 Publications
 ------------
@@ -23,7 +14,6 @@ compression algorithm, along with many new features.
 We are preparing a new paper that will describe all these
 changes in detail.
 
-
 `Wang, Chen, Jinghan Sun, Marc Snir, Kathryn Mohror, and Elsa
 Gonsiorowski. “Recorder 2.0: Efficient Parallel I/O Tracing and
 Analysis.” In IEEE International Workshop on High-Performance Storage
@@ -51,14 +41,15 @@ Requirements of HPC Applications.” Proceedings of the 30th International
 Symposium on High-Performance Parallel and Distributed Computing (HPDC).
 2021. <https://dl.acm.org/doi/abs/10.1145/3431379.3460637>`__
 
+
 .. toctree::
-   :maxdepth: 1
    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
diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
@@ -1,9 +1,3 @@
-Recorder
-========
-
-**A Multi-Level Library for Understanding I/O Activity in HPC
-Applications**
-
 Quickstart
 ----------