Skip to content

Commit 70d429f

Browse files
committed
Docs: Fix Cmd Help
Fix calls to `--help` in commands auto-build into the manual.
1 parent 1a1ad65 commit 70d429f

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

USAGE.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ It does a copy from an already existing set of input files (e.g. our examples or
108108

109109
See ``pic-create --help`` for more options during input set creation:
110110

111-
.. program-output:: ../../pic-create --help
111+
.. program-output:: ../../bin/pic-create --help
112112

113113
A run simulation can also be reused to create derived input sets via ``pic-create``:
114114

@@ -149,7 +149,7 @@ For example, if you want to build for running on CPUs instead of a GPUs, call:
149149
150150
Its full documentation from ``pic-build --help`` reads:
151151

152-
.. program-output:: ../../pic-build --help
152+
.. program-output:: ../../bin/pic-build --help
153153

154154
pic-configure
155155
"""""""""""""
@@ -183,7 +183,7 @@ For running on a CPU instead of a GPU, set this:
183183

184184
See ``pic-configure --help`` for more options during input set configuration:
185185

186-
.. program-output:: ../../pic-configure --help
186+
.. program-output:: ../../bin/pic-configure --help
187187

188188
After running configure you can run ``ccmake .`` to set additional compile options (optimizations, debug levels, hardware version, etc.).
189189
This will influence your build done via ``make``.

docs/source/usage/param.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ For example, if you want to edit the *grid* and time step resolution, *file outp
2424
2525
See ``pic-edit --help`` for all available files:
2626

27-
.. program-output:: ../../pic-edit --help
27+
.. program-output:: ../../bin/pic-edit --help
2828

2929
Rationale
3030
---------

docs/source/usage/tbg.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ todo: explain idea and use case
1717
Usage
1818
^^^^^
1919

20-
.. program-output:: ../../src/tools/bin/tbg --help
20+
.. program-output:: ../../bin/tbg --help
2121

2222
.. _usage-cfg:
2323

0 commit comments

Comments
 (0)