From 04aeedb8614d0909cb8396bd3ef1eb31dc4a2347 Mon Sep 17 00:00:00 2001
From: Michael Buehlmann <buehlmann.michi@gmail.com>
Date: Tue, 29 Mar 2022 21:28:49 -0500
Subject: [PATCH] fix formatting in executable documentation
---
docs/executables/tools.rst | 19 ++++++++++++-------
1 file changed, 12 insertions(+), 7 deletions(-)
diff --git a/docs/executables/tools.rst b/docs/executables/tools.rst
index ce3c9b7..c05f74f 100644
--- a/docs/executables/tools.rst
+++ b/docs/executables/tools.rst
@@ -19,10 +19,15 @@ GenericIOPrint
inspect GenericIO file and print data to stdout
-.. code-block::
+.. code-block:: none
Usage: GenericIOPrint [--no-rank-info|--no-data|--show-map] <filename>
+ Options:
+ --no-rank-info don't print source rank information (coords and #rows)
+ --no-data don't print data
+ --show-map ???
+
--------------------------------------------------------------------------------
.. _doc-GenericIOVerify:
@@ -32,7 +37,7 @@ GenericIOVerify
verify and try reading data
-.. code-block::
+.. code-block:: none
Usage: GenericIOVerify [-v] <filename1> [<filename2> ...]
@@ -48,7 +53,7 @@ GenericIORewrite
rewrite data with a different number of ranks
-.. code-block::
+.. code-block:: none
Usage: GenericIORewrite <filenameOld> <filenameNew>
@@ -61,9 +66,9 @@ GenericIOBenchmarkRead
reading benchmark, works on data written with ``GenericIOBenchmarkWrite``
-.. code-block::
+.. code-block:: none
- USAGE: GenericIOBenchmarkRead [-a] <filename>
+ Usage: GenericIOBenchmarkRead [-a] <filename>
Options:
-a UseAOS (Array-Of-Structures for pos and vel)
@@ -77,9 +82,9 @@ GenericIOBenchmarkWrite
writing benchmark
-.. code-block::
+.. code-block:: none
- USAGE: GenericIOBenchmarkWrite [-a] [-c] [-l] <filename> <NP> <seed>
+ Usage: GenericIOBenchmarkWrite [-a] [-c] [-l] <filename> <NP> <seed>
Options:
-a UseAOS (Array-Of-Structures for pos and vel)
--
GitLab