[docs] Sphinx API hosted on GitHub Pages

[j0yu]

Build Sphinx API docs and host it using GitHub Pages for the current repository:

https://wwfxuk.github.io/rez/

• Switched to use ReadTheDocs theme
• Publish only on master branch
  • Built HTML available as CI artefacts
• Platform independent way to build docs python docs/entrypoint.py (add --no-docker to just install locally)

Thought this might be a starting point to have some API docs available:

• When developing rez plugins, it will be more intuitive to have the references available
• Help keep in check the docstrings written can actually be compiled by Sphinx

[j0yu]

About 60d21f4, I originally included it just to make sure users on any platform/python version can build the docs for themselves locally.

It's to make sure we don't end up with any unintended surprises in any API docs Python scripts if we start adding any in the future.

That said, if anyone PRs anything, I guess as long as it builds on GitHub and releases, that is what really matters at the end of the day. People can download the generated artefact and view the static, generated pages locally if they want to check.

[j0yu]

Also, I find the GitHub Pages settings can be a bit stubborn and either:

• Take a while to take effect or,
• Needs a couple of cycles of setting/un-setting it for it to take effect
  

[nerdvegas]

Ah cheers, I actually had to go enable it actually. It's working now. A

…

On Tue, Aug 11, 2020 at 9:23 PM Joe Yu ***@***.***> wrote: Also, I find the GitHub Pages settings can be a bit stubborn and either: - Take a while to take effect or, - Needs a couple of cycles of setting/un-setting it for it to take effect [image: image] <https://user-images.githubusercontent.com/9294702/89891637-58a1d180-dbcd-11ea-8197-e50aba0f509b.png> — You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub <#832 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAMOUSV2IJZRLDANMGRT3T3SAESZRANCNFSM4KEQCUJA> .