Re-enable doc workflow

[devclinton]

• Re-enable documentation workflow
• Enable through dispatch

[devclinton]

@lgeorge-idm , this is mostly your workflow. I can't test the last step directly

      - name: Commit Docs
        run: |
          pushd gh-pages
          if [ ! -z "$(git status --porcelain)" ]; then
            git config --local user.email "action@github.com"
            git config --local user.name "GitHub Action"
            git add --all .
            git commit -m "Update Docs"

            # Setup deploy key
            eval "$(ssh-agent -s)"
            ssh-add - <<< "${{ secrets.DOCS_DEPLOY_KEY }}"
            # Deploy
            remote_repo="git@github.com:${{ github.repository }}.git"
            git push "${remote_repo}" HEAD:gh-pages
          fi
          popd

It looks pretty much same as covasim so I think it is ok. I tried testing locally but it was getting too many issues. Can you confirm it was working?

[JSchripsema-IDM]

Just checking--we are pushing this to the synthpops code repo correct? Not a second repo? There's a lot of big data files here, so aren't concerned with the HTML docs inflating the size of the repository and don't want to add more complexity.

[ckerr-IDM]

@JSchripsema-IDM thanks for checking -- longer-term, my personal vote would be for a separate repo, synthpops-docs, where we can serve the built pages from, as we have for covasim. however, for now, synthpops has ~200 mb of files committed to it, so the extra ~10 mb that the docs add shouldn't matter. if at a future data we decide to remove the data files, we'll need to rebase the repository anyway, so can choose at that point if we want to separate out the docs into a separate repo. we may also want to do this if we move to jupyter notebook docs (which, with images, can easily exceed 100 mb). but tldr, should be fine to merge for now :)