Add github workflow file to deploy docs to pages

[thomaszwagerman]

Publishing docs to Github Pages on push to main.

A repeat of #51, which was closed without merging by accident during the hectic last few minutes of the hack day!

This will require @RayStick to configure publishing source in the repo settings.

Also see mkdocs publishing instructions.

If this is moving across to TTW(?) it might be easier to hold off merging until that is done?

[RayStick]

Thanks @thomaszwagerman I made the changes - does that look right?
Or will the GitHub pages site be built from a different branch?
Good point about possibly holding off if we are moving to TTW. Thoughts @JimMadge or @sgibson91 ?

[thomaszwagerman]

I think under Branch main will have to become gh-pages, but that branch won't exist until we activate this action.

(it might do that automatically though, I can't remember)

[sgibson91]

I think @JimMadge and I would be happy to move this repo to TTW's org if there's no objections from the rest of the hackday team?

[JimMadge]

If we do a proper GitHub migrate, I think we retain the issues, PRs, and so on.

Might need to give @RayStick extra permissions temporarily on @the-turing-way to do that. If you let me know if/when you'd like to do that I can sort it out 👍.

[sgibson91]

@RayStick if you give either/both myself and @JimMadge Owner rights to the repo, we can move it ourselves :)

[RayStick]

@JimMadge I requested a transfer to your account! (@sgibson91 it did not work for you, probably because you have a fork of the same name). Hopefully this allows you to then bring it to TTW og😌

[JimMadge]

I think changing my or @sgibson91's role to Owner is probably the best solution. That way we can avoid transferring the repo twice. Or, can you request a transfer directly to The Turing Way?

[RayStick]

Sure. I need write access to transfer direct to TTW org. I didn't see an option to add you as an owner, but let me check again!

EDIT: A personal public GH repo doesn't seem to have as many granular options for permissions for collaborators. It needs to be a repo within an organization for that

[JimMadge]

@RayStick I've sent you an invitation to the org, that should give you the permission to create repos (and hence transfer this repo 🤞). Let me know if that works.

[RayStick]

Done 🥳

[thomaszwagerman]

@sgibson91 @JimMadge now that this is on TTW - do feel free do adapt the docs/hosting methods completely as you see fit, if there is some standardised theme/hosting infrastructure this should align to etc

[RayStick]

@sgibson91 @JimMadge now that this is on TTW - do feel free do adapt the docs/hosting methods completely as you see fit, if there is some standardised theme/hosting infrastructure this should align to etc

And let me know if I can help with the docs in any way :)

[JimMadge]

Some suggestions.

Most importantly, I think we shouldn't have a different build command here than in the pyproject.toml.

[JimMadge]

@sgibson91 @JimMadge now that this is on TTW - do feel free do adapt the docs/hosting methods completely as you see fit, if there is some standardised theme/hosting infrastructure this should align to etc

GitHub Pages seems sensible to me.

[RayStick]

What needs to be done to get this documentation PR merged?

It is out of date now, so I am hesitant to be the one that reviews and merges it - @sgibson91 and @JimMadge what do you think?

[JimMadge]

LGTM