Skip to content

Commit 705b37b

Browse files
committed
tweak formatting
1 parent 90a7410 commit 705b37b

File tree

3 files changed

+35
-27
lines changed

3 files changed

+35
-27
lines changed

webdocs/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
This directory contains the source files that are used to construct the web pages that are displayed in https://advancedphotonsource.github.io/GSAS-II-tutorials/. If editing these files and one wants to see the formatted contents, use the command:
2+
3+
make html
4+
open _build/html/index.html
5+
6+
note that sphinx must be installed, as well as sphinx_readable_theme (`pip install sphinx_readable_theme`)

webdocs/compile.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -399,15 +399,15 @@ may wish to change above) and will use git to clone the
399399
AdvancedPhotonSource/GSAS-II repo placing all files in subdirectory
400400
``~/G2/GSAS-II``. The script does the following things:
401401

402-
* it checks that the Python installation has the packages that GSAS-II
403-
needs to run (`see here for details
404-
<https://gsas-ii.readthedocs.io/en/latest/packages.html#python-requirements>`_)
405-
and for compilation.
406-
* It installs or updates the GSAS-II files from the GitHub repo
407-
* It creates the and installs the appropriate binary files from the
408-
Fortran, C and Cython sources.
409-
* It does a byte-compile on all ``.py`` files
410-
* it creates shortcuts/icons for starting GSAS-II (OS specific)
402+
* Checks that the Python installation has the packages that GSAS-II
403+
needs to run (`see here for details
404+
<https://gsas-ii.readthedocs.io/en/latest/packages.html#python-requirements>`_)
405+
and for compilation.
406+
* Installs or updates the GSAS-II files from the GitHub repo
407+
* Creates the and installs the appropriate binary files from the
408+
Fortran, C and Cython sources.
409+
* Does a byte-compile on all ``.py`` files
410+
* Creates shortcuts/icons for starting GSAS-II (OS specific)
411411

412412
Note that there are a number of options that can be used with the
413413
script, for example ``python gitcompile.py --reset`` overwrites any

webdocs/install.rst

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -125,15 +125,16 @@ may wish to change above) and will use git to clone the
125125
AdvancedPhotonSource/GSAS-II repo placing all files in subdirectory
126126
``~/G2/GSAS-II``. The script does the following things:
127127

128-
* it checks that the Python installation has the packages that GSAS-II
129-
needs to run (`see here for details
130-
<https://gsas-ii.readthedocs.io/en/latest/packages.html#python-requirements>`_)
131-
* It installs or updates the GSAS-II files from the GitHub repo
132-
* It downloads and installs the appropriate binary files from the
133-
`GSAS-II releases
134-
<https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases>`_
135-
* It does a byte-compile on all ``.py`` files
136-
* it creates shortcuts/icons for starting GSAS-II (OS specific)
128+
* Checks that the Python installation has the packages that GSAS-II
129+
needs to run (`see here for details
130+
<https://gsas-ii.readthedocs.io/en/latest/packages.html#python-requirements>`_)
131+
and for compilation.
132+
* Installs or updates the GSAS-II files from the GitHub repo
133+
* Downloads and installs the appropriate binary files from the
134+
`GSAS-II releases <https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases>`_
135+
* Does a byte-compile on all ``.py`` files
136+
* Creates shortcuts/icons for starting GSAS-II (OS specific)
137+
137138

138139
Note that there are a number of options that can be used with the
139140
script, for example ``python gitstrap.py --reset`` overwrites any
@@ -177,15 +178,16 @@ may wish to change above) and will use git to clone the
177178
AdvancedPhotonSource/GSAS-II repo placing all files in subdirectory
178179
``~/G2/GSAS-II``. The script does the following things:
179180

180-
* it checks that the Python installation has the packages that GSAS-II
181-
needs to run (`see here for details
182-
<https://gsas-ii.readthedocs.io/en/latest/packages.html#python-requirements>`_)
183-
and for compilation.
184-
* It installs or updates the GSAS-II files from the GitHub repo
185-
* It creates the and installs the appropriate binary files from the
186-
Fortran, C and Cython sources.
187-
* It does a byte-compile on all ``.py`` files
188-
* it creates shortcuts/icons for starting GSAS-II (OS specific)
181+
* Checks that the Python installation has the packages that GSAS-II
182+
needs to run (`see here for details
183+
<https://gsas-ii.readthedocs.io/en/latest/packages.html#python-requirements>`_)
184+
and for compilation.
185+
* Installs or updates the GSAS-II files from the GitHub repo
186+
* Creates the and installs the appropriate binary files from the
187+
Fortran, C and Cython sources.
188+
* Does a byte-compile on all ``.py`` files
189+
* Creates shortcuts/icons for starting GSAS-II (OS specific)
190+
189191

190192
Note that there are a number of options that can be used with the
191193
script, for example ``python gitcompile.py --reset`` overwrites any

0 commit comments

Comments
 (0)