Draft: Description of XPS peak fitting

.github/workflows/ci.yaml

@@ -3,17 +3,24 @@ name: CI
 on:
   push:
     branches:
-      - main   # push commit to the main branch
+      - main
+      - fairmat   # push commit to the fairmat branch
   pull_request:
     branches:
-      - main   # pull request to the main branch
+      - main
+      - fairmat   # pull request to the fairmat branch
   workflow_dispatch:   # allow manual triggering
     inputs:
       deploy:
         description: 'Deploy documentation'
         type: boolean
         required: true
         default: false
+      upload:
+        description: 'Upload documentation (pdfs in _static/)'
+        type: boolean
+        required: true
+        default: false
 
 defaults:
   run:
@@ -25,19 +32,25 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
       max-parallel: 5
     env:
       python_version: ${{ matrix.python-version }}
+      python_deploy_version: '3.8' # version to use for deployment
 
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
 
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
       - name: Deploy Information
-        if: ${{ github.event.inputs.deploy && env.python_version == '3.7' }}
+        if: ${{ github.event.inputs.deploy && env.python_version == env.python_deploy_version }}
         run: |
           echo "The HTML NeXus User Manual will be pushed to"
           echo " https://github.com/nexusformat/definitions/tree/gh-pages"
@@ -66,34 +79,39 @@ jobs:
             texlive-latex-recommended \
             texlive-latex-extra \
             texlive-fonts-recommended
+          tex --version
 
       - name: Generate build files
+        env:
+          GH_TOKEN: ${{ (env.python_version == env.python_deploy_version && (github.event.inputs.deploy || github.event.inputs.upload)) && secrets.GITHUB_TOKEN  || 'NONE' }}
         run: |
           make prepare
 
-      - name: Build Impatient Guid
+      - name: Build Impatient Guide
         run: |
           make impatient-guide
           ls -lAFgh build/impatient-guide/build/html/index.html
-          ls -lAFgh build/impatient-guide/build/latex/NXImpatient.pdf
+          mkdir -p build/html
+          mv build/impatient-guide/build/html build/html/impatient
 
       - name: Build User Manual
         run: |
           make pdf
           make html
           ls -lAFgh build/manual/build/html/index.html
-          ls -lAFgh build/manual/build/latex/nexus.pdf
+          mkdir -p build/html
+          mv build/manual/build/html/* build/html
 
-      - name: Build and Commit the User Manual
-        if: ${{ github.event.inputs.deploy && env.python_version == '3.7' }}
-        uses: sphinx-notes/pages@master
+      - name: Deploy both the User Manual and the Impatient Guide
+        if: ${{ github.event.inputs.deploy && env.python_version == env.python_deploy_version }}
+        uses: JamesIves/github-pages-deploy-action@v4
         with:
-          # path to the conf.py directory
-          documentation_path: build/manual/source
+          token: ${{ secrets.GITHUB_TOKEN }}
+          folder: build/html
 
-      - name: Deploy the User Manual
-        if: ${{ github.event.inputs.deploy && env.python_version == '3.7' }}
-        uses: ad-m/github-push-action@master
+      - name: Upload the User Manual and the Impatient Guide
+        if: ${{ github.event.inputs.upload && env.python_version == env.python_deploy_version }}
+        uses: actions/upload-artifact@v3
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          branch: gh-pages
+          name: nexus-definitions-docs
+          path: build/html

.github/workflows/fairmat-build-pages.yaml

@@ -0,0 +1,49 @@
+name: GH pages fairmat proposal
+
+on:
+  push:
+    branches: [fairmat]
+  pull_request:
+    branches: [fairmat]
+
+jobs:
+  pages:
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.9"
+    - name: install dependencies
+      run: pip install -r requirements.txt
+    - name: Get branch name
+      id: branch-name
+      uses: tj-actions/branch-names@v7
+    - name: test
+      run: make test
+    - name: prepare
+      run: make prepare
+    - name: html
+      run: make html
+    - name: Deploy
+      if: steps.branch-name.outputs.is_default == 'true'
+      uses: JamesIves/github-pages-deploy-action@v4
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        folder: build/manual/build/html
+        branch: fairmat-docs
+        target-folder: docs
+        clean: false
+    - name: Deploy PR
+      if: steps.branch-name.outputs.is_default == 'false'
+      uses: JamesIves/github-pages-deploy-action@v4
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        folder: build/manual/build/html
+        branch: fairmat-docs
+        target-folder: docs/${{ steps.branch-name.outputs.current_branch }}
+        clean: false

.github/workflows/fairmat-clean-pages.yaml

@@ -0,0 +1,27 @@
+name: GH pages cleanup
+
+on:
+  delete:
+
+jobs:
+  cleanup:
+    if: github.event.ref_type == 'branch'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout pages
+        uses: actions/checkout@v2
+        with:
+          ref: fairmat-docs
+          persist-credentials: false
+          fetch-depth: 0
+      - name: Remove branch directory
+        run: rm -rf docs/${{ github.event.ref }}
+      - name: Get current date
+        id: date
+        run: echo "::set-output name=date::$(date +'%Y-%m-%d')"
+      - name: Commit & Push changes
+        uses: actions-js/push@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: fairmat-docs
+          message: Fairmat docs cleanup ${{ steps.date.outputs.date }}

.github/workflows/fairmat-nxdl-yaml-consistency.yaml

@@ -0,0 +1,29 @@
+name: Check nxdl/yaml consistency
+
+on:
+  push:
+    branches: [fairmat]
+  pull_request:
+    branches: [fairmat]
+
+jobs:
+  check_nxdl:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.9"
+    - name: Checkout Repository
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: install dependencies
+      run: pip install -r requirements.txt
+    - name: make nxdls
+      run: make nxdl
+    - uses: CatChen/check-git-status-action@v1
+      with:
+        fail-if-not-clean: true
+        request-changes-if-not-clean: false
+        push-if-not-clean: false

.gitignore

@@ -1,5 +1,6 @@
 # Hidden files
 .*
+!.github
 
 # Python byte / compiled / optimized
 *.py[cod]
@@ -9,6 +10,24 @@ __pycache__/
 build/
 makelog.txt
 
-# Unknown
-/python/
-__github_creds__.txt
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+*_parsed.yaml

MANIFEST.in

@@ -0,0 +1,4 @@
+recursive-include applications/ *.nxdl.xml
+recursive-include contributed_definitions/ *.nxdl.xml
+recursive-include base_classes/ *.nxdl.xml
+include ./ *.xsd