chg: add gh workflow for sphinx build/deploy

* cleanup docs config, remove dicey sphinx_git extension
* switch readme badge, download wheel artifacts to single directory

Signed-off-by: Stephen Arnold <[email protected]>

Author: sarnold

.github/workflows/main.yml

@@ -106,8 +106,9 @@ jobs:
     steps:
       - uses: actions/download-artifact@v4
         with:
+          merge-multiple: true
           path: artifacts
 
       # note wheels should be in subdirectories named <artifact_name>
       - name: Check number of downloaded artifacts
-        run: ls -l artifacts/*
+        run: ls -l artifacts/

.github/workflows/sphinx.yml

@@ -0,0 +1,49 @@
+name: Docs
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.9'
+
+    - name: Add python requirements
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox
+
+    - name: Install Ubuntu build deps
+      run: |
+        sudo apt-get -qq update
+        sudo apt-get install -y libre2-dev
+
+    - name: Build docs
+      run: |
+        tox -e ldocs,docs
+
+    - uses: actions/upload-artifact@v4
+      with:
+        name: ApiDocsHTML
+        path: "docs/_build/html/"
+
+    - name: set nojekyll for github
+      run: |
+        sudo touch docs/_build/html/.nojekyll
+
+    - name: Deploy docs to gh-pages
+      if: ${{ github.event_name == 'push' }}
+      uses: JamesIves/github-pages-deploy-action@v4
+      with:
+        folder: docs/_build/html/

README.rst

@@ -18,8 +18,8 @@
    :target: https://badge.fury.io/py/pyre2
     :alt: Pypi version
 
-.. image:: https://github.com/andreasvc/pyre2/workflows/Conda/badge.svg
-    :target: https://github.com/andreasvc/pyre2/actions?query=workflow:Conda
+.. image:: https://github.com/andreasvc/pyre2/actions/workflows/conda-dev.yml/badge.svg
+    :target: https://github.com/andreasvc/pyre2/actions/workflows/conda-dev.yml
     :alt: Conda CI Status
 
 .. image:: https://img.shields.io/github/license/andreasvc/pyre2

docs/source/conf.py

@@ -42,9 +42,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx_git',
     'sphinxcontrib.apidoc',
-    'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',

docs/source/index.rst

@@ -1,13 +1,6 @@
 Welcome to the Pyre2 documentation!
 ===================================
 
-.. git_commit_detail::
-    :branch:
-    :commit:
-    :sha_length: 10
-    :uncommitted:
-    :untracked:
-
 .. toctree::
     :caption: Contents:
     :maxdepth: 3

setup.cfg

@@ -27,7 +27,6 @@ setup_requires =
 [options.extras_require]
 doc =
     sphinx
-    sphinx_git
     sphinx_rtd_theme
     sphinxcontrib-apidoc