Deploy docs

[krishnans2006]

Currently a work-in-progress, using sphinx-to-github-pages.

[krishnans2006]

The error:

  Running Sphinx v7.3.7
  
  Configuration error:
  The module you specified in the configuration 'django_settings' in your conf.py cannot be imported. Make sure the module path is correct and the source directory is added to sys.path.
  Error: Process completed with exit code 1.

[JasonGrace2282]

Might be a good idea to lock in the python version (the default is python 3.10, but it's better to be explicit, especially with #22 coming up)

On another note, are you able to reproduce the issue locally? I am not...

If needed we can do it manually with something like this, which works in the testing ci

name: Deploy docs

on:
  push:
    branches: [master]

permissions:
  contents: write

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
      - name: Install dependencies
        run: |
          pip install -r docs/requirements.txt
      - name: Sphinx build
        run: |

          cd docs
          make html
       - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: './build'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

[krishnans2006]

On another note, are you able to reproduce the issue locally? I am not...

I'm not able to either - I did a bunch of testing and it seems like the root directory is indeed added to sys.path, which is quite interesting.

Your workflow idea looks pretty amazing - I'll try it out.

[krishnans2006]

Done! Implemented in 173a7d8.