Skip to content

Commit

Permalink
web page updates; add help pages to site via Actions
Browse files Browse the repository at this point in the history
  • Loading branch information
briantoby committed Apr 4, 2024
1 parent ebdcecd commit 5a30967
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 15 deletions.
11 changes: 11 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,17 @@ jobs:
- name: Sphinx build
run: |
sphinx-build webdocs . # place output into root dir
# get the help pages from the GSAS-II sources into the web site
- name: Get GSAS-II
run: |
git clone --depth 1 https://github.com/AdvancedPhotonSource/GSAS-II.git _gsas2
- name: move help into site
run: |
mv _gsas2/GSASII/help ./help
- name: Get rid of the rest of the GSAS-II files
run: |
rm -rf _gsas2
- name: Upload artifact # creates zip file with website contents
uses: actions/upload-pages-artifact@v3
Expand Down
5 changes: 4 additions & 1 deletion webdocs/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@ Help pages
-----------------------

The GSAS-II GUI provides context-based help via several web files that are
distributed with the program, :strike:`as well as can be` `viewed here <https://subversion.xray.aps.anl.gov/pyGSAS/trunk/help/gsasII-index.html>`_. This help is not always complete, but does provide some information on how different sections of the program work.
distributed with the program, as well as can be `viewed here
<help/gsasII-index.html>`_. These help pages are not always complete,
but do provide information on how different sections of the program
work.

Developer's Documentation
----------------------------
Expand Down
2 changes: 1 addition & 1 deletion webdocs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Please help us by citing

Also, please do sign up for the ​GSAS-II mailing list `see below <mailinglist.html>`_.
We add new features to GSAS-II quite frequently, so we may break
things from time to time `(see bug reporting, below <bug.html>)`_. Be
things from time to time (`(see bug reporting, below <bug.html>`_). Be
sure to use the Help-->Update capability frequently to stay abreast of
new features and fixes as they are added and please make sure to use
the latest version before reporting a bug to us, but *please* do report
Expand Down
10 changes: 5 additions & 5 deletions webdocs/install-g2f-linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ Detailed Description of the Linux Installation Process
The exact details for how the installation is performed will depend on "flavor" of Linux in use. Here I am using Ubuntu.

.. image:: ./linux_inst_images/1.png
:scale: 25 %
:scale: 30 %
:alt: commands in terminal window
:align: right

1) In a terminal window paste the commands::
1) In a terminal window paste the commands::

g2="https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2full-Latest-Linux-x86_64.sh"
curl -L "$g2" > /tmp/g2.sh; bash /tmp/g2.sh -b -p ~/g2full
Expand All @@ -33,18 +33,18 @@ The exact details for how the installation is performed will depend on "flavor"
:alt: completion commands in terminal window
:align: right

2) This will run for a few minutes (or longer depending on download speeds) and then the conda installation process will start, with the display of lots of text. At the end, the terminal window will appear as seen to the right. Note the addition of the GSASII file on the desktop (this may not happen on all Linux desktop managers.). The installation has been completed.
2) This will run for a few minutes (or longer depending on download speeds) and then the conda installation process will start, with the display of lots of text. At the end, the terminal window will appear as seen to the right. Note the addition of the GSASII file on the desktop (this may not happen on all Linux desktop managers.). The installation has been completed.

.. raw:: html

<div class="clear"></div>

.. image:: ./linux_inst_images/3.png
:scale: 25 %
:scale: 45 %
:alt: activate terminal icon
:align: right

3) Note the red "X" on the desktop icon and the "grayed-out" colors. This is because by default new icons are disabled. Right-click on the icon and select "Allow launching" from the menu. The "X" disappears and colors return to normal, as seen in the upper right.
3) Note the red "X" on the desktop icon and the "grayed-out" colors. This is because by default new icons are disabled. Right-click on the icon and select "Allow launching" from the menu. The "X" disappears and colors return to normal, as seen in the upper right.

Clicking on the icon will open GSAS-II. Likewise a GSAS-II project (.gpx) file can be dragged onto the icon to open that file in GSAS-II.

16 changes: 8 additions & 8 deletions webdocs/install-g2f-mac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ Detailed Description of the Mac Installation Process

1) The first step in this process is to open a terminal window. There are many ways on a Mac to do this, but one of the most easy is to click on the magnifying glass for Spotlight, as shown to the right, and then type terminal and finally click on the terminal application.


.. raw:: html

<div class="clear"></div>


.. image:: ./mac_inst_images/2.png
:scale: 40 %
:alt: terminal commands
:align: right

2) Into the terminal window paste these commands (for an ARM aka "Apple Silicon" or M1, M2,... Mac)::
2) Into the terminal window paste these commands (for an ARM aka "Apple Silicon" or M1, M2,... Mac)::
g2="https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2full-Latest-MacOSX-arm64.sh"
curl -L "$g2" > /tmp/g2.sh; bash /tmp/g2.sh -b -p ~/g2full
Expand All @@ -50,7 +50,7 @@ Detailed Description of the Mac Installation Process
:alt: start of download
:align: right

3) Once Return is pressed, the download of the installation kit file is started, which may take a while (typically minutes), depending on your internet connection speed.
3) Once Return is pressed, the download of the installation kit file is started, which may take a while (typically minutes), depending on your internet connection speed.

.. raw:: html

Expand All @@ -61,7 +61,7 @@ Detailed Description of the Mac Installation Process
:alt: download complete
:align: right

4) After the download is complete, the installation starts and that usually completes in a minute or two, as seen to the right.
4) After the download is complete, the installation starts and that usually completes in a minute or two, as seen to the right.

.. raw:: html

Expand All @@ -72,20 +72,20 @@ Detailed Description of the Mac Installation Process
:alt: drag to doc
:align: right

5) The installer will create a Mac app as a shortcut for running GSAS-II and will open the folder containing it. You cannot move that app from the folder. You can start GSAS-II by double-clicking this icon or by dropping a GSAS-II project (.gpx) file on it.
5) The installer will create a Mac app as a shortcut for running GSAS-II and will open the folder containing it. You cannot move that app from the folder. You can start GSAS-II by double-clicking this icon or by dropping a GSAS-II project (.gpx) file on it.

You can, if you wish, drag it to the doc, as seen to the right. In the doc, you can also start GSAS-II by single-clicking this icon or by dropping a GSAS-II project (.gpx) file on it.

.. raw:: html

<div class="clear"></div>

. image:: ./mac_inst_images/6.png
.. image:: ./mac_inst_images/6.png
:scale: 40 %
:alt: download complete
:align: right

6) Alternately, if you do want to place the shortcut somewhere, for example in the desktop, you can create an alias of the app by control-clicking on the icon (or right-clicking with a three-button mouse) and select "Make Alias" in the pop-up menu. This will create a new copy of the GSAS-II icon labeled "GSAS-II alias". You can then start GSAS-II by double-clicking this icon or by dropping a GSAS-II project (.gpx) file on it.
6) Alternately, if you do want to place the shortcut somewhere, for example in the desktop, you can create an alias of the app by control-clicking on the icon (or right-clicking with a three-button mouse) and select "Make Alias" in the pop-up menu. This will create a new copy of the GSAS-II icon labeled "GSAS-II alias". You can then start GSAS-II by double-clicking this icon or by dropping a GSAS-II project (.gpx) file on it.

.. raw:: html

Expand All @@ -96,7 +96,7 @@ Detailed Description of the Mac Installation Process
:alt: download complete
:align: right

7) Once the alias icon is created, it can be dragged to any folder or the desktop. Once moved, it can be renamed if desired.
7) Once the alias icon is created, it can be dragged to any folder or the desktop. Once moved, it can be renamed if desired.

.. raw:: html

Expand Down

0 comments on commit 5a30967

Please sign in to comment.