Skip to content

Commit e871920

Browse files
committed
fix some help formatting
1 parent b7bf65e commit e871920

File tree

4 files changed

+23
-23
lines changed

4 files changed

+23
-23
lines changed

webdocs/help.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,17 @@ either using a utility to place a copy elsewhere, or you can use the
2222
git stash, branch or commit commands. The commands below will
2323
overwrite your changes with the latest GSAS-II version.
2424

25-
On windows
25+
On Windows
2626
----------------
2727

2828
At present, two windows .BAT files are created in the directory where
29-
GSAS-II is installed, one named `Reset2FreshGSASII.bat` the other
30-
`start_G2_bootstrap.bat`. Thus, if GSAS-II is installed in directory
31-
`C:\Users\toby\gsas2main` the files will be named
32-
`C:\Users\toby\gsas2main\Reset2FreshGSASII.bat` and
33-
`C:\Users\toby\gsas2main\start_G2_bootstrap.bat`.
29+
GSAS-II is installed, one named ``Reset2FreshGSASII.bat`` the other
30+
``start_G2_bootstrap.bat``. Thus, if GSAS-II is installed in directory
31+
``C:\Users\toby\gsas2main`` the files will be named
32+
``C:\Users\toby\gsas2main\Reset2FreshGSASII.bat`` and
33+
``C:\Users\toby\gsas2main\start_G2_bootstrap.bat``.
3434
Either will restore the GSAS-II files, but the
35-
`Reset2FreshGSASII` file, will ask you to confirm before acting. The
35+
``Reset2FreshGSASII`` file, will ask you to confirm before acting. The
3636
files can run by locating them in the Windows File Explorer and
3737
double-clicking on it or by typing the file name into the cmd.exe
3838
window.
@@ -41,11 +41,11 @@ On MacOS and Linux
4141
------------------------
4242

4343
At the time this is being written, an error prevents the script from
44-
running, but this can be corrected by editing the `reset-gsasII.sh`
45-
file manually (see below). Note that this file is placed in the `bin` directory
44+
running, but this can be corrected by editing the ``reset-gsasII.sh``
45+
file manually (see below). Note that this file is placed in the ``bin`` directory
4646
immediately below the GSAS-II installation directory. Thus, if
47-
GSAS-II is installed at location `/Users/toby/G2/gsas2main` then the
48-
file will be named `/Users/toby/G2/gsas2main/bin/reset-gsasII.sh`. (It
47+
GSAS-II is installed at location ``/Users/toby/G2/gsas2main`` then the
48+
file will be named ``/Users/toby/G2/gsas2main/bin/reset-gsasII.sh``. (It
4949
will appear in the path if conda is initialized.) Depending on the OS,
5050
it may be possible to locate and run this file in a system-supplied
5151
file browser, or type the file name into a terminal window.

webdocs/install-g2f-linux.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,11 @@ Command-line options
7070

7171
The bash installation command above uses two options:
7272

73-
* `-b` for batch mode, so that no questions are asked and
74-
* `-p <path>` which specifies where GSAS-II will be installed.
73+
* ``-b`` for batch mode, so that no questions are asked and
74+
* ``-p <path>`` which specifies where GSAS-II will be installed.
7575

7676
One other option is available:
7777

78-
* `-f` for force, which will cause the GSAS-II installation to proceed
78+
* ``-f`` for force, which will cause the GSAS-II installation to proceed
7979
even when there are files in the installation location. This should
8080
only be used to reinstall GSAS-II if needed.

webdocs/install-g2f-mac.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,11 +113,11 @@ Command-line options
113113

114114
The bash installation command above uses two options:
115115

116-
* `-b` for batch mode, so that no questions are asked and
117-
* `-p <path>` which specifies where GSAS-II will be installed.
116+
* ``-b`` for batch mode, so that no questions are asked and
117+
* ``-p <path>`` which specifies where GSAS-II will be installed.
118118

119119
One other option is available:
120120

121-
* `-f` for force, which will cause the GSAS-II installation to proceed
121+
* ``-f`` for force, which will cause the GSAS-II installation to proceed
122122
even when there are files in the installation location. This should
123123
only be used to reinstall GSAS-II if needed.

webdocs/install-g2f-win.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -207,8 +207,8 @@ should be the same on all computers. E.g., if GSAS-II is installed
207207
in ``C:\software\GSASII`` it can be copied to a directory with the
208208
same name on other computers and used from that location, but not to
209209
``E:\software\GSASII`` or ``C:\Users\someone\GSASII``. A supplied
210-
script (`...\GSASII\install\makeBat.py`) can be run to register the
211-
`.gpx` extension so that clicking on a GSAS-II project will open it in GSAS-II.
210+
script (``...\GSASII\install\makeBat.py``) can be run to register the
211+
``.gpx`` extension so that clicking on a GSAS-II project will open it in GSAS-II.
212212

213213

214214
Command-line options
@@ -221,7 +221,7 @@ https://github.com/conda/constructor/blob/main/CONSTRUCT.md#installer_type
221221

222222
Potentially useful commands would be:
223223

224-
* `/S` for "silent" (batch) mode, so that no questions are asked and
225-
* `/D=<path>` which specifies the location where GSAS-II will be
226-
installed (`/D=E:\software\GSASII`)
227-
* `/?` displays the available options.
224+
* ``/S`` for "silent" (batch) mode, so that no questions are asked and
225+
* ``/D=<path>`` which specifies the location where GSAS-II will be
226+
installed (``/D=E:\software\GSASII``)
227+
* ``/?`` displays the available options.

0 commit comments

Comments
 (0)