Generation of new docs via Github Actions

[vyrzdev]

This should work great, although I'd like to hear your input on how I'm overwriting the existing branch completely.
Theres a little bit of hackiness when I include the library in the PYTHONPATH env variable to get it to import properly in conf.py.

Currently the workflow is:

• Generate Docs
• Copy generated docs into a swap folder
• Checkout into gh-pages branch
• Delete all existing files on the branch <-- I am unsure if this is what you want.
• Copy in newly generated docs from the swap folder
• Add all changes
• Commit, but hide the exit code if no changes are made overall.
• Push

[rossmacarthur]

Hey @vyrzdev 👋, thanks for the PR.

I'll share some of my thoughts as to how this can be improved:

Since sphinx builds the docs to docs/_build/html I think you should use @actions/checkout to checkout the repo on the gh-pages branch at that path (so there will be two checkouts in the workflow). Then you can run just docs which will update the data in docs/_build/html. Then you can add and commit that data, for this you can probably use something like @stefanzweifel/git-auto-commit-action with the repository value set to docs/_build/html.

[rossmacarthur]

I would prefer if this was just docs. Same with the file name.

[rossmacarthur]

Not sure I understand why this is here 🤔. I think it would be assumed that the docs would be built from the branch running the workflow not always from master.

[rossmacarthur]

See my comment on the PR about using an action for this