doc ci

[salman01zp]

Summary of changes
Changes introduced in this pull request:

Reference issue to close (if applicable)

Closes #225

[dutterbutter]

@salman01zp To ensure the docs publication works, I would suggest commenting out this line in .github/workflows/publish-docs.yml:

    if: github.event_name == 'push' && github.event.ref == 'refs/heads/main'

Commenting this out, will run the docs job on a pull request. If it succeeds to publish, then uncomment to ensure we skip this job until merge into main.

I will close #205 in favour of this PR.

[dutterbutter]

Closing in favour of #232