DOC: Building via CI

.github/workflows/docs.yml

@@ -0,0 +1,70 @@
+name: Pull Request Tests
+
+on:
+  push:
+    tags:
+      - '*'
+    branches:
+      - main
+      - release/*
+      - feature/*
+
+permissions:
+  contents: write
+
+jobs:
+  docs-build:
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    runs-on: ubuntu-latest
+
+    steps:
+      # SETUP
+      ############################
+      - name: Checkout code
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+        with:
+          ref: ${{ github.head_ref }}  # Ensure branch is checked out, not detached state (so we can push a commit later)
+          token: ${{ secrets.GITHUB_TOKEN }}
+          persist-credentials: true  # Ensure that the token is available for pushing changes
+
+      - name: Set up Python
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97
+        with:
+          python-version: 3.x
+
+      - name: Add checkout directory to PYTHONPATH
+        run: echo "PYTHONPATH=$(pwd):$PYTHONPATH" >> $GITHUB_ENV
+
+      - name: Install dependencies
+        id: install-dependencies
+        run: |
+          pip install .[tests,dev]
+          pip uninstall dagrunner -y
+
+      # DOCUMENTATION
+      ############################
+      - name: Build documentation
+        run: |
+          rm -rf ./docs/_build
+          mkdir -p ./docs/_build
+          ./docs/gen_docs dagrunner ./docs/_build
+
+      - name: Check if documentation has changed
+        id: check-docs
+        run: |
+          echo "changed=$(git diff --quiet --exit-code || echo true)" | tee -a $GITHUB_OUTPUT
+
+      # https://github.com/orgs/community/discussions/26560#discussioncomment-3531273
+      # This must be our very final step to ensure that it runs only on condition of
+      # success of all previous steps.  A pushed commit will not trigger the re-running
+      # of this workflow.
+      - name: Commit and push documentation changes
+        if: steps.check-docs.outputs.changed == 'true'
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+          git add docs/.
+          git commit -am "Automated reference documentation update for PR ${{ github.event.number }} [skip ci]"
+          git push
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -16,7 +16,7 @@ DAGrunner takes advantage of the native markdown rendering support provided by g
 
 ## API
 
-See [DAGrunner API](docs/dagrunner_index.md)
+See [DAGrunner API](docs/_build/dagrunner_index.md)
 
 ## License/copyright
 
@@ -52,7 +52,7 @@ See [docs/demo.ipynb](docs/demo.ipynb)
 DAGrunner concerns itself with graph execution and does not strictly require processing modules (plugins) to take any particular form.  That is, you may or may not choose to use or subclass the plugins provided by DAGrunner.
 However, for convenience, DAGrunner does define some plugins which fall into two broad categories, some abstract and some for use as they are.
 
-See [here](docs/dagrunner.plugin_framework.md) for more information.
+See [here](docs/_build/dagrunner.plugin_framework.md) for more information.
 
 ## Schedulers
 
@@ -63,7 +63,7 @@ These range from [dask](https://www.dask.org/), [ray](https://docs.ray.io/en/lat
 ## Logging and monitoring
 
 DAGrunner provides a script `dagrunner-logger` for running a TCP server.  This enables logging to function across the network.  Additionally, it will write logs to an sqlite database to aid in realtime monitoring from external tools.
-See [logger](docs/dagrunner.utils.logger.md) for more information.
+See [logger](docs/_build/dagrunner.utils.logger.md) for more information.
 
 ## Logo