MAINT: Deploy docs

[larsoner]

MAINT: Deploy docs

[larsoner]

... you can see the expected failure here because the deploy key is not actually set up for the pyvistaqt-docs repo:

https://github.com/pyvista/pyvistaqt/actions/runs/5180508643/jobs/9334776061

Relevant docs for the action (but feel free to switch to a different one if you want):

https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-set-ssh-private-key-deploy_key

[banesullivan]

Do we need a separate, dedicated repo to host the docs for this package? Why not just gh-pages branch of this repo? AFAIK, these docs are not massive in size (like PyVista proper and the justification for it having its own repo)

[banesullivan]

I say just use gh-pages branch of this repo and avoid the cross-repo deploy key stuff

[larsoner]

I'm mostly just saying what appeared to be done previously. We could probably switch to a gh-pages branch in this repo in principle. In practice it's probably more work and reconfiguration (I don't know how things are configured for pyvista.org so you'd probably have to do some of it) and has the disadvantage of potentially bloating the repo if the doc build ever gets big. Squashing and checking out/cloning single branch works around this but is always more work.

Overall I'm not totally opposed, more of just want to make sure some potential disadvantages and challenges are aired before we decide to try it

[larsoner]

(by comparison, creating a repo or org level key is very easy I think -- if you can make me admin of the Qt docs repo I can do it)

[larsoner]

Okay I created a SSH deploy key, added the private key as a repo secret ACTIONS_DEPLOY_KEY in this repo, and added the public key as a deploy key in pyvistaqt-docs (where you either gave me or I already had permissions to do it!) and now it's working!

• https://github.com/pyvista/pyvistaqt/actions/runs/5189730092/jobs/9355133734
• https://qtdocs.pyvista.org/

[banesullivan]

Fantastic! Thanks for handling all of this!