Skip to content

Commit

Permalink
Fix docs highlighting, TOC depth
Browse files Browse the repository at this point in the history
  • Loading branch information
nsheff committed Jul 13, 2017
1 parent 6c0df02 commit 7336267
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Contents

.. toctree::
:caption: Getting Started
:maxdepth: 0
:maxdepth: 1

intro.rst
hello-world.rst
Expand Down
14 changes: 7 additions & 7 deletions doc/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Here you can see the command-line usage instructions for the main looper command
``looper --help``
----------------------------------

.. code-block:: shell
.. code-block:: none
version: 0.6.0-dev
usage: looper [-h] [-V] {run,summarize,destroy,check,clean} ...
Expand All @@ -47,7 +47,7 @@ Here you can see the command-line usage instructions for the main looper command
``looper run --help``
----------------------------------

.. code-block:: shell
.. code-block:: none
version: 0.6.0-dev
usage: looper run [-h] [-t TIME_DELAY] [--ignore-flags] [--compute COMPUTE]
Expand Down Expand Up @@ -80,7 +80,7 @@ Here you can see the command-line usage instructions for the main looper command
``looper summarize --help``
----------------------------------

.. code-block:: shell
.. code-block:: none
version: 0.6.0-dev
usage: looper summarize [-h] [--file-checks] [-d] [--sp SUBPROJECT]
Expand All @@ -101,7 +101,7 @@ Here you can see the command-line usage instructions for the main looper command
``looper destroy --help``
----------------------------------

.. code-block:: shell
.. code-block:: none
version: 0.6.0-dev
usage: looper destroy [-h] [--file-checks] [-d] [--sp SUBPROJECT] config_file
Expand All @@ -121,7 +121,7 @@ Here you can see the command-line usage instructions for the main looper command
``looper check --help``
----------------------------------

.. code-block:: shell
.. code-block:: none
version: 0.6.0-dev
usage: looper check [-h] [--file-checks] [-d] [--sp SUBPROJECT] config_file
Expand All @@ -141,7 +141,7 @@ Here you can see the command-line usage instructions for the main looper command
``looper clean --help``
----------------------------------

.. code-block:: shell
.. code-block:: none
version: 0.6.0-dev
usage: looper clean [-h] [--file-checks] [-d] [--sp SUBPROJECT] config_file
Expand All @@ -161,7 +161,7 @@ Here you can see the command-line usage instructions for the main looper command
``looper --help --details``
----------------------------------

.. code-block:: shell
.. code-block:: none
version: 0.6.0-dev
usage: looper [-h] [-V] [--logfile LOGFILE] [--verbosity {0,1,2,3,4}] [--dbg]
Expand Down
2 changes: 1 addition & 1 deletion update-usage-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ for cmd in "--help" "run --help" "summarize --help" "destroy --help" "check --he
echo -e "----------------------------------" >> USAGE_header.temp
looper $cmd --help > USAGE.temp 2>&1
sed -i 's/^/\t/' USAGE.temp
sed -i '1s/^/\n.. code-block:: shell\n\n/' USAGE.temp
sed -i '1s/^/\n.. code-block:: none\n\n/' USAGE.temp
#sed -i -e "/\`looper $cmd\`/r USAGE.temp" -e '$G' usage.template # for -in place inserts
cat USAGE_header.temp USAGE.temp >> usage.template # to append to the end
done
Expand Down

0 comments on commit 7336267

Please sign in to comment.