Deploy documentation to GH pages (v2)

[rth]

Follow up on #367 this time from an upstream branch to check as secrets are not shared to forks.

Just checking that git clone with an SSH key works for the docs repo. Not writing anything there.

[rth]

@ulupo So overall this should work. It looks like knownHostsEntry for adding SSH keys was not well documented in Azure pipelines and I had to manually generate ~/.ssh/known_hosts file. Adding commits to https://github.com/giotto-ai/gtda-docs now works (see git log there).

Next steps would be to,

• copy the built docs in the right folder of gtda-docs (see TODO folder I left in the setup). Friday afternoon is probably not be best time to deploy so I'll leave that for later :)
• Also there is actually an issue with building the docs with the version selector,

  File "/Users/runner/runners/2.165.2/work/1/s/doc/conf.py", line 121, in <module>
    with open('versions', 'r') as f:
FileNotFoundError: [Errno 2] No such file or directory: 'versions'

maybe @wreise you would what missing to make it work?

Generally feel free to push into this branch.

[wreise]

Amazing, this is what was missing!

The error regarding versions is normal. In fact, we are not using make html, but, we have targets:

• make all-gh- generate the theory, execute notebooks, generate the html, and copy to the appropriate gtda-docs folder,
• make gh-commit which stages and commit the changes.

Anyway, I will refactor (+rename) these steps and use them in the azure pipeline, but the crucial thing (THANKS!) is that with what you propose, we can commit to gh.

[wreise]

@ulupo , I don't remember what we agreed on for triggering changes in the documentation - sorry. Would you mind recalling?

[rth]

Great, thanks @wreise !

Yeah, I can't see an objective reason why it wouldn't work previously according to the docs. I ended up looking for similar setups on Github, one of them did this and it does fix the problem.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
3 out of 4 committers have signed the CLA.

✅ rth
✅ ulupo
✅ wreise
❌ Umberto

---

Umberto seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}