remove references to old help; start on moving help into GSASII/newhelp

Author: briantoby

.github/workflows/test_builddocsite.yml

@@ -14,8 +14,12 @@
 
 name: build GSAS-II web site w/test MD Help
 
-#on: [workflow_dispatch] 
-on: [push, workflow_dispatch]
+on:
+  workflow_dispatch:
+  
+  push:
+    branches:  
+      - newhelp
 
 permissions:
   contents: write
@@ -29,13 +33,14 @@ jobs:
 
       - name: Python setup
         uses: actions/setup-python@v3
-      - name: Sphinx setup
-        run: |
-          pip install sphinx sphinx_readable_theme
-      - name: pandoc setup
-        uses: pandoc/actions/setup@v1
+# Code below removed for more rapid testing
+      # - name: Sphinx setup
+      #   run: |
+      #     pip install sphinx sphinx_readable_theme
+      # - name: pandoc setup
+      #   uses: pandoc/actions/setup@v1
 
-      # MD help stuff
+      # MD help tools
       - name: install debian chrome
         run: |
           set -ex
@@ -55,19 +60,18 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      # MD help stuff
+      # MD help conversion
       - name: convert MDhelp
         run: |
           cd MDhelp
           mkdocs build
-          cp -vr site ../help_test
           ENABLE_PDF_EXPORT=1 mkdocs build
           mv site/GSASII-help.pdf ../docs/
           # create an anchor index
           python findMDanchors.py
-          cp -vr site ../help_test
+          cp -vr site ../help
           
-      # - name: Upload help artifact  # creates zip file with website contents
+      # - name: Upload help artifact  # debug: creates zip file with website contents
       #   uses: actions/upload-pages-artifact@v3
       #   with:
       #       path: MDhelp/site
@@ -78,33 +82,35 @@ jobs:
         run: |
           curl -L https://github.com/AdvancedPhotonSource/GSAS-II/raw/master/GSASII/tutorialIndex.py -o scripts/tutorialIndex.py
 
-      - name: convert tutorials
-        run: |
-          cd MDtutorials
-          for path in ./*; do
-            [ -d "${path}" ] || continue # skip if not a directory
-            dirname="$(basename "${path}")"
-            dest="../${dirname}"
-            mkdir -pv ${dest}
-            [ ! -d "${path}/data" ] || cp -r "${path}/data" ${dest}/
-            [ ! -d "${path}/imgs" ] || cp -r "${path}/imgs" ${dest}/
-            cp tutorial.css ${dest}
-            for fil in $dirname/*.md; do
-              outfile="${dest}/$(basename "${fil%.md}.html")"
-              echo "creating $outfile from $fil"
-              pandoc --standalone ${fil} --css tutorial.css -o ${outfile}
-              sed -i "s/<figure>/<BR clear=all><figure>/g" ${outfile}
-            done
-            git add ${dest}
-          done
-          cd ..
+# Code below removed for more rapid testing
+      # - name: convert tutorials
+      #   run: |
+      #     cd MDtutorials
+      #     for path in ./*; do
+      #       [ -d "${path}" ] || continue # skip if not a directory
+      #       dirname="$(basename "${path}")"
+      #       dest="../${dirname}"
+      #       mkdir -pv ${dest}
+      #       [ ! -d "${path}/data" ] || cp -r "${path}/data" ${dest}/
+      #       [ ! -d "${path}/imgs" ] || cp -r "${path}/imgs" ${dest}/
+      #       cp tutorial.css ${dest}
+      #       for fil in $dirname/*.md; do
+      #         outfile="${dest}/$(basename "${fil%.md}.html")"
+      #         echo "creating $outfile from $fil"
+      #         pandoc --standalone ${fil} --css tutorial.css -o ${outfile}
+      #         sed -i "s/<figure>/<BR clear=all><figure>/g" ${outfile}
+      #       done
+      #       git add ${dest}
+      #     done
+      #     cd ..
 
-      - name: build tutorials index 
-        run: |
-          cd scripts
-          python makeGitTutorial.py ..
+# Code below removed for more rapid testing
+      # - name: build tutorials index 
+      #   run: |
+      #     cd scripts
+      #     python makeGitTutorial.py ..
 
-#      - name: Note changed files
+#      - name: Note changed files  # unused development code
 #        run: |
 #            git add tutorials.html
 #            git add */data/index.html
@@ -113,44 +119,49 @@ jobs:
 #      - name: Push changes
 #        uses: ad-m/github-push-action@master
 
-      - name: Sphinx build
-        run: |
-          sphinx-build webdocs .  # place output into root dir
-          cp webdocs/_static/fix.css _static/fix.css # should be done by sphinx
+# Code below removed for more rapid testing
+      # - name: Sphinx build
+      #   run: |
+      #     sphinx-build webdocs .  # place output into root dir
+      #     cp webdocs/_static/fix.css _static/fix.css # should be done by sphinx
 
-      # to be replaced by MD help stuff
-      # get the help pages from the GSAS-II sources into the web site
+      # get the new help pages into the GSAS-II sources
       - 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
+          cp -rpv MDhelp/site _gsas2/GSASII/help
+          cd _gsas2
+          git status
+
+      # before uploading, clean up
       - name: Get rid of the rest of the GSAS-II files & other stuff not needed on web
         run: |
           rm -rf _gsas2 webdocs scripts MDtutorials MDhelp
-        
-      - name: Upload artifact  # creates zip file with website contents
-        uses: actions/upload-pages-artifact@v3
-        with:
-            path: .
-            name: github-pages
-            retention-days: 1
-
-  deploy:   # Deployment of web pages to GitHub pages
-    needs: build     
-    permissions:
-      pages: write
-      id-token: write
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
+
+# Code below removed for more rapid testing
+  #     - name: Upload artifact  # creates zip file with website contents
+  #       uses: actions/upload-pages-artifact@v3
+  #       with:
+  #           path: .
+  #           name: github-pages
+  #           retention-days: 1
+
+  # deploy:   # Deployment of web pages to GitHub pages
+  #   needs: build     
+  #   permissions:
+  #     pages: write
+  #     id-token: write
+  #   environment:
+  #     name: github-pages
+  #     url: ${{ steps.deployment.outputs.page_url }}
+  #   runs-on: ubuntu-latest
 
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
-        with:
-           token: ${{ secrets.GITHUB_TOKEN }}
-           artifact_name: github-pages
+  #   steps:
+  #     - name: Deploy to GitHub Pages
+  #       id: deployment
+  #       uses: actions/deploy-pages@v4
+  #       with:
+  #          token: ${{ secrets.GITHUB_TOKEN }}
+  #          artifact_name: github-pages

README.md

@@ -8,7 +8,11 @@ This repository contains files used to create GSAS-II web content, which include
 
 * **Tutorials**: When the tutorials will be run, It is best to access them from within GSAS-II using the Help->Tutorials menu (this will simplifies downloading the files needed to run the tutorials), but tutorials can also be accessed [from this link](https://advancedphotonsource.github.io/GSAS-II-tutorials/tutorials.html). The HTML, images and data files for the tutorials are found in this repo. Note that when new functionality is added to GSAS-II, it is customary to create a new tutorial. 
 
-* **Help Pages**: There are three HTML web pages used within GSAS-II (plus a table of contents page) for context-sensitive help. These files are maintained in the [GSAS-II source code repo](https://github.com/AdvancedPhotonSource/GSAS-II/tree/master/GSASII/help), but for convenience, [they can also be accessed from the web pages](https://advancedphotonsource.github.io/GSAS-II-tutorials/help/gsasII-index.html).
+* **Help Pages**: There are a set of web files that are
+distributed with GSAS-II, or can be [viewed here](help/index.html). These 
+help pages provide information on how different sections of the program
+work. The help information can also be viewed [as a PDF document](https://advancedphotonsource.github.io/GSAS-II-tutorials/docs/GSASII-help.pdf).
+Comments, corrections, additions and issue reports on Help are most welcome. 
 
 ## Repo Organization
 Each tutorial is placed here in its own subdirectory. In that subdirectory, there will be a web page for that tutorial (extension .html or .htm) and two additional subdirectories, one named `data`, with the input file(s) needed for that tutorial and another with a name generated from the web page file name that contains images for the web page. 

fullrmc-SF6/fullrmc-SF6.html

@@ -1615,7 +1615,7 @@ <h2><a name=install>Installing fullrmc</a></h2>
 mso-bidi-theme-font:major-bidi'>When fullrmc is selected on the Phase RMC tab
 (as will be done below), GSAS-II will look for a fullrmc program in a number of
 locations (<a
-href="https://subversion.xray.aps.anl.gov/pyGSAS/trunk/help/gsasII-phase.html#Phase-RMC">documented
+href="https://advancedphotonsource.github.io/GSAS-II-tutorials/help/phaseRMC.html#fullrmc">documented
 here</a>). If this is not found, the program will offer to install it for you,
 as below.<o:p></o:p></span></p>
 
@@ -1720,9 +1720,9 @@ <h2><a name=install>Installing fullrmc</a></h2>
 href="https://github.com/bachiraoun/fullrmc/tree/master/standalones">https://github.com/bachiraoun/fullrmc/tree/master/standalones</a>.
 If this is done manually, either install it into the search path described in
 the <a
-href="https://subversion.xray.aps.anl.gov/pyGSAS/trunk/help/gsasII-phase.html#Phase-RMC">GSAS-II
+href="https://advancedphotonsource.github.io/GSAS-II-tutorials/help/phaseRMC.html#fullrmc">GSAS-II
 help</a> or define the GSAS-II <a
-href="https://subversion.xray.aps.anl.gov/pyGSAS/trunk/help/gsasII-phase.html#Preferences">configuration
+href="https://advancedphotonsource.github.io/GSAS-II-tutorials/help/others.html#Preferences">configuration
 variable</a> </span><span class=SpellE><tt><span style='mso-ansi-font-size:
 16.0pt;mso-bidi-font-size:16.0pt;font-family:"Times New Roman",serif;
 mso-ascii-theme-font:major-bidi;mso-fareast-font-family:"Times New Roman";

webdocs/compile.rst

@@ -388,12 +388,13 @@ Compiling with Scons
 Compilation with scons (as opposed to meson, as discussed above) is not
 recommended and will be removed from GSAS-II in the future. It will
 work only with Python 3.11 or older and only with the ``master``
-branch. Do not use GSAS-II will fail with Python earlier than 3.7 and may have
-some errors even with Python 3.8.
+branch. Note that GSAS-II will fail with Python earlier than 3.7 and may have
+some errors even with Python 3.8-3.10 as it is no longer tested on
+those environments.
 
 The compilation process requires installation of the gcc and GFortran
 compilers. Others will probablu not work. Also, the Python Scons
-package must be installed into Python. compilation is done with
+package must be installed into Python. Compilation is then done with
 commands::
 
     cd fsource
@@ -408,7 +409,8 @@ Installation of compilers is highly depend on the computer system being used, bu
 Use the ``conda search gfortran`` command to find the name for the package. 
 On most linux systems, one can use a command such as ``sudo apt-get gfortran`` or ``yum install gcc-gfortran``. Also see https://gcc.gnu.org/wiki/GFortranBinaries for more information.
 
-Note that the intent is that this Scons-based process will be replaced with one to run under meson in mid-2024. In the meantime, some older web pages discussing compiling GSAS-II may be of use:
+Note that the intent is that this Scons-based process is no longer in
+use, but for reference some older web pages discussing compiling GSAS-II may be of use:
 
  * https://subversion.xray.aps.anl.gov/trac/pyGSAS/wiki/CompilingWindows
  * https://subversion.xray.aps.anl.gov/trac/pyGSAS/wiki/InstallMacHardWay#CompilingFortranCode

webdocs/documentation.rst

@@ -23,19 +23,17 @@ Some older tutorials have video copies, so you can see the computer screen as th
 Help pages
 -----------------------
 
-The GSAS-II GUI provides context-based help via several web files that are
+The GSAS-II GUI provides context-based help via web files that are
 distributed with the program, as well as can be `viewed here
-<help/gsasII-index.html>`_. These help pages are not always complete,
+<help/index.html>`_. These help pages are not always complete,
 but do provide information on how different sections of the program
-work.
-
-The help documentation is in the process of being reformatted and updated. The
-`new help pages can be viewed here<help-test/>`_ as web pages or
-`here as a PDF document
+work. The help information can also be viewed `as a PDF document
 <https://advancedphotonsource.github.io/GSAS-II-tutorials/docs/GSASII-help.pdf>`_.
-These files are now based in MarkDown (simple text) input files found
-`in GitHub<https://github.com/AdvancedPhotonSource/GSAS-II-tutorials/tree/main/MDhelp>`_.
-Comments, corrections, additions and issue reports are most welcome. 
+
+Note that the help documentation was recently reformatted and updated
+as MarkDown (simple text) input files found
+`here in GitHub<https://github.com/AdvancedPhotonSource/GSAS-II-tutorials/tree/main/MDhelp>`_.
+Comments, corrections, additions and issue reports on Help are most welcome. 
 
 .. index:: Source code documentation