try combined build

Author: briantoby

.github/workflows/mkdocs_pdf.yml

@@ -3,8 +3,8 @@
 
 name: test MD help to .pdf
 
-#on: [workflow_dispatch] 
-on: [push, workflow_dispatch]
+on: [workflow_dispatch] 
+#on: [push, workflow_dispatch]
 
 permissions:
   contents: write
@@ -16,23 +16,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-
-      # - name: Set up Node.js
-      #   uses: actions/setup-node@v4
-
-      # - name: Install RelaxedJS globally
-      #   run: npm install -g relaxedjs
-      # #- name: Install RelaxedJS locally
-      # #  run: npm install relaxedjs
-
-      # - name: find relaxedjs
-      #   run: |
-      #     which relaxed
-
-      # - name: test installed chrome
-      #   run: |
-      #     which chrome
-      #     chrome --version
+      - 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
 
       - name: install debian chrome
         run: |
@@ -45,30 +35,6 @@ jobs:
 #          which google-chrome-stable
 #          google-chrome-stable --version
 #          /usr/bin/google-chrome-stable --headless --disable-gpu --dump-dom https://google.com
-          
-      # - name: Setup chromium
-      #   uses: browser-actions/setup-chrome@v1
-      #   id: setup-chrome
-      #   with:
-      #     install-dependencies: true
-      #     install-chromedriver: true
-      # - run: |
-      #     echo ${{ steps.setup-chrome.outputs.chrome-path }} --version
-      #     ${{ steps.setup-chrome.outputs.chrome-path }} --version
-      # - name: test installed chrome
-      #   run: |
-      #     ${{ steps.setup-chrome.outputs.chrome-path }} --no-sandbox --headless --disable-gpu --dump-dom https://google.com
-      # - name: test system chromium
-      #   run: |
-      #     /usr/bin/chromium-browser --no-sandbox --headless --disable-gpu --dump-dom https://google.com
-      
-      - 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
       - name: mkdocs setup
         run: |
           pip install mkdocs mkdocs-material python-markdown-math mkdocs-static-i18n

.github/workflows/test_builddocsite.yml

@@ -1,18 +1,19 @@
 # create a documentation web site for GSAS-II from four sources
 #  * HTML tutorials are simply copied
 #  * markdown tutorials (in ./MDtutorials) are formatted with pandoc and are copied over
-#  * HTML help files are copied over from the GSAS-II sources
 #  * sphinx is used to generate HTML from files in ./webdocs
 
 # Also the tutorials.html file and the */data/index.html files are
 #     created by running scripts/makeGitTutorial
 
 # this is a development version that creates draft help pages from the MDhelp directory
+For now
+#  * HTML help files are copied over from the GSAS-II sources
 
-name: test MD help w/build GSAS-II web site
+name: build GSAS-II web site w/test MD Help
 
-on: [workflow_dispatch] 
-#on: [push, workflow_dispatch]
+#on: [workflow_dispatch] 
+on: [push, workflow_dispatch]
 
 permissions:
   contents: write
@@ -29,21 +30,45 @@ jobs:
       - name: Sphinx setup
         run: |
           pip install sphinx sphinx_readable_theme
-          #pip install mkdocs-to-pdf
       - name: pandoc setup
         uses: pandoc/actions/setup@v1
+
+      # MD help stuff
+      - name: install debian chrome
+        run: |
+          set -ex
+          wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
+          sudo apt install ./google-chrome-stable_current_amd64.deb
+   
+#      - name: test newly-installed chrome
+#        run: |
+#          which google-chrome-stable
+#          google-chrome-stable --version
+#          /usr/bin/google-chrome-stable --headless --disable-gpu --dump-dom https://google.com
       - name: mkdocs setup
         run: |
           pip install mkdocs mkdocs-material python-markdown-math mkdocs-static-i18n
+          pip install mkdocs-to-pdf pymdown-extensions
 
       - name: Checkout
         uses: actions/checkout@v4
 
+      # MD help stuff
       - 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/
+          cp -vr site ../help_test
+          
+      # - name: Upload help artifact  # creates zip file with website contents
+      #   uses: actions/upload-pages-artifact@v3
+      #   with:
+      #       path: MDhelp/site
+      #       name: MDhelp
+      #       retention-days: 1
 
       - name: Get tutorials index from source code
         run: |
@@ -89,6 +114,7 @@ jobs:
           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
       - name: Get GSAS-II
         run: |

MDhelp/docs/index.md

@@ -10,18 +10,20 @@ right corner of the data window. Access to specific help information
 is also offered on the graphics
 window and in other locations of the program. 
 
+<a name="Index"></a> 
 An index on the topics covered in these help pages is given below. 
 
-<a name="Index"></a>
 1. [Tutorials](./preface.md)  
-2. [GSAS-II GUI Organization](./applicationwindow.md)
+2. [GSAS-II GUI Organization](./applicationwindow.md) 
     1. [Data Tree](./applicationwindow.md#Data_tree)
-    1. [Data Window](./applicationwindow.md#Data_frame)
-    1. [Graphics Window](./applicationwindow.md#Plots)
-    1. [Console Window](./applicationwindow.md#Console) 
+    2. [Data Window](./applicationwindow.md#Data_frame)
+    3. [Graphics Window](./applicationwindow.md#Plots)
+    4. [Console Window](./applicationwindow.md#Console)
 3. [Main menu contents](./mainmenu.md)
 4. Data tree entries and their use ([overview](./datatree.md))
-    1. [Universal data tree](./commontreeitems.md) items
+    1. [Universal data tree](./commontreeitems.md) items 
+    0. [Sequential results](./sequential.md)
+    0. [Cluster Analysis](./cluster.md)
     2. [Phase Data Tree items (overview)](./phaseoverview.md) 
         * [General Phase tab](./phasegeneral.md)  
         * [Data Phase tab](./phasedata.md) 
@@ -54,7 +56,6 @@ An index on the topics covered in these help pages is given below.
         * Reflection List
     6. [Pair Distribution Functions (PDF)](./pairdistribution.md) Data Tree entries
     8. [Small Angle Scattering (SASD)](./smallanglescattering.md) Data Tree entries
-    9. [Reflectometry (REFD)](./reflectometry.md) Data Tree entries
-    0. [Sequential results](./sequential.md)
-    0. [Cluster Analysis](./cluster.md)
+    9. [Reflectometry (REFD)](./reflectometry.md) Data Tree entries 
+    9. [Powder Peaks (PKS)](./peaks.md) Data Tree entries 
  5. [Others](./others.md): Macintosh notes, Configuration options and Programmers' documentation

MDhelp/mkdocs.yml

@@ -8,6 +8,8 @@ nav:
   - Data tree items:
     - Data tree overview: datatree.md
     - Universal items: commontreeitems.md
+    - Sequential results: sequential.md
+    - Cluster Analysis: cluster.md
     - Phases:
       - Phase overview: phaseoverview.md  
       - General tab: phasegeneral.md
@@ -42,8 +44,7 @@ nav:
     - PDF: pairdistribution.md
     - Small Angle (SASD): smallanglescattering.md
     - Reflectometry (REFD): reflectometry.md
-    - Sequential results: sequential.md
-    - Cluster Analysis: cluster.md
+    - Powder Peaks (PKS): peaks.md
 
 #    - Powder peaks (PKS): powderpeak.md
 
@@ -57,6 +58,15 @@ theme:
   logo:    images/gsas2.png
 
 plugins:
+  - to-pdf:
+      author: Brian H. Toby and Robert B. Von Dreele
+      enabled_if_env: ENABLE_PDF_EXPORT
+      cover_title: GSAS-II Help information
+      cover_subtitle: A compilation of HTML pages into PDF
+      copyright: From https://advancedphotonsource.github.io/GSAS-II-tutorials/help/
+      output_path: GSASII-help.pdf
+      render_js: true
+      headless_chrome_path: /usr/bin/google-chrome-stable
   - i18n:
       docs_structure: suffix
       languages:
@@ -71,11 +81,14 @@ plugins:
 markdown_extensions:
   - def_list
   - admonition
-  - mdx_math
+#  - mdx_math
+  - pymdownx.arithmatex:
+      generic: true
 
-extra_javascript: 
-  - https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
-#  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js # MathJax library from CDN
+extra_javascript:
+  - javascripts/mathjax.js
+  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
+#  - https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
 
 #local build settings from https://www.mkdocs.org/user-guide/deploying-your-docs/#local-files
 

MDhelp/mkdocs.yml_pdf

@@ -99,7 +99,6 @@ extra_javascript:
 #  - https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
 #  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js # MathJax library from CDN
 
-
 #local build settings from https://www.mkdocs.org/user-guide/deploying-your-docs/#local-files
 
 site_url: ""