drop nsls2forge

.github/workflows/publish-docs.yml → .github/workflows/docs.yml

@@ -19,20 +19,20 @@ on:
         required: true
         default: false
 
-# see: https://sphinx-notes.github.io/pages/
-# see: https://github.com/marketplace/actions/sphinx-to-github-pages
+defaults:
+  run:
+    shell: bash -l {0}
 
 jobs:
-
-  publish-docs:
-    name: Publish documentation
+  docs:
     runs-on: ubuntu-latest
-
     steps:
+    - uses: actions/setup-python@v2
+
     - name: Checkout
       uses: actions/checkout@master
       with:
-        fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
+        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
 
     - name: Deploy Information
       if: ${{ github.event.inputs.deploy }}
@@ -41,7 +41,8 @@ jobs:
 
     - name: Install pandoc
       run: |
-        sudo apt-get update && sudo apt-get -y install pandoc python3-pip
+        sudo apt-get update && \
+        sudo apt-get -y install pandoc
 
     - name: Install Sphinx build requirements
       run: |
@@ -51,19 +52,30 @@ jobs:
       run: |
         pip install --no-deps -e .
 
-    - name: Diagnostics
+    - name: Diagnostic
       run: |
-        pip list
+        echo $(which pandoc)
+        echo $(which sphinx-build)
 
-    - name: Build and Commit
-      uses: sphinx-notes/pages@master
-      with:
-        # path to conf.py directory
-        documentation_path: docs/source
+    - name: Sphinx
+      run: |
+        make -C docs html
+
+    # - name: Integrity check
+    #   run: |
+    #     sphinx-build \
+    #       docs/source \
+    #       -W \
+    #       -b linkcheck \
+    #       -d \
+    #         docs/build/doctrees \
+    #         docs/html
 
     - name: Publish (push gh-pages branch) only on demand
+      uses: peaceiris/actions-gh-pages@v3
       if: ${{ github.event.inputs.deploy }}
-      uses: ad-m/github-push-action@master
       with:
+        publish_branch: gh-pages
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        branch: gh-pages
+        publish_dir: _build/
+        force_orphan: true

CHANGES.rst

@@ -23,11 +23,15 @@ describe the future plans.
 
    release expected by 2023-02-01
 
-..
-   1.6.10
-   ******
+1.6.10
+******
+
+release expected by 2023-01-06
+
+Maintenance
+------------
 
-   release expected by 2023-01-06
+* Remove ``nsls2forge`` channel from conda environment.
 
 1.6.9
 ******

apstools/callbacks/tests/test_filewriter.py

@@ -268,13 +268,10 @@ def test_SpecWriterCallback_writer_default_name(cat, tempdir):
     assert scan.header.raw.find("\n#O0 \n") > 0
     assert scan.header.raw.find("\n#o0 \n") > 0
     assert len(scan.header.O) == 1
-    assert len(scan.header.O[0]) == 0
     assert len(scan.header.o) == 1
-    assert len(scan.header.o[0]) == 0
 
     assert scan.raw.find("\n#P0 \n") > 0
     assert len(scan.P) == 1
-    assert len(scan.P[0]) == 0
     assert len(scan.positioner) == 0
 
 

docs/source/conf.py

@@ -37,6 +37,8 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = """
+    IPython.sphinxext.ipython_console_highlighting
+    IPython.sphinxext.ipython_directive
     sphinx.ext.autodoc
     sphinx.ext.autosummary
     sphinx.ext.coverage
@@ -76,5 +78,6 @@
     psutil
     pyRestTable
     pysumreg
+    spec2nexus
     xarray
 """.split()

environment.yml

@@ -4,8 +4,6 @@ channels:
   - aps-anl-tag
   - conda-forge
   - defaults
-  # nsls2forge channel for newer mongoquery 1.3.6 (issue #673)
-  - nsls2forge
 
 dependencies:
   - python >=3.8, <=3.11

requirements-sphinx.txt

@@ -1,7 +1,9 @@
+ipython
+jinja2 >=3.0
 markupsafe ==2.0.1
 myst-parser
 nbsphinx
 pydata-sphinx-theme
 pygments >=2.12
-jinja2 >=3.0
+pygments-ipython-console
 setuptools-scm