Previews in pull requests

[hugovk]

Fixes#70.

#70 suggested Read the Docs and Netlify, but we have a bit of a bus factor problem with Netlify on the CPython docs due to only having a single account that can access the admin, so let's use Read the Docs as well. We're using it successfully in the PEPs repo.

Here's a demo build:

• https://readthedocs.org/projects/hugovk-python-docs-theme/builds/19337266/
• https://hugovk-python-docs-theme.readthedocs.io/en/rtd-preview/

Draft because:

• This builds upon create Makefile for faster iteration #93 plus my suggestions. I'll rebase after it's merged.

And we need to set up Read the Docs:

• Someone with admin to this repo (because it needs to set up the webhooks; I don't have admin) should import it at https://readthedocs.org/dashboard/import/
• I suggest we use the python-docs-theme-previews slug (consistent with peps-previews at https://github.com/python/peps)
• Add some more maintainers at https://readthedocs.org/dashboard/python-docs-theme-previews/users/ to improve bus factor

[hugovk]

Ping @Mariatta

[JDLH]

I wasn't aware of the term "bus factor". For the information of others like me, it refers to a risk that critical roles in a project are limited to a small number of people, in the sense of "in case they get hit by a bus". There is a nice Wikipedia article, Bus factor.

[Mariatta]

Project created: https://readthedocs.org/projects/python-docs-theme-previews/

Who else should I add as maintainers?

[hugovk]

Thanks! Maybe @JulienPalard, @ezio-melotti and me?

[pradyunsg]

I'd be happy to be listed as well, if we don't have enough people. :)

[Mariatta]

I'll need your readthedocs usernames: @hugovk, @pradyunsg, @JulienPalard, @ezio-melotti

[pradyunsg]

I'm pradyunsg (perhaps, unsurprisingly).

[hugovk]

I'm hugovk (perhaps, unsurprisingly).

[Mariatta]

Invites sent.

[hugovk]

I'll close this and re-open it as a new PR, and hopefully it will trigger an RTD build 🤞

[hugovk]

Nope, didn't trigger for #107, re-opening this.

It worked on my fork, I'll compare settings:

• Previews in pull requests hugovk/python-docs-theme#1
• https://readthedocs.org/dashboard/hugovk-python-docs-theme/webhooks/

[hugovk]

OK, so the incoming GitHub webhook is good on my fork (at https://readthedocs.org/dashboard/hugovk-python-docs-theme/integrations/225260/):

Details

And I also see a webhook (at https://github.com/hugovk/python-docs-theme/settings/hooks):

Details

But not for this repo (at https://readthedocs.org/dashboard/python-docs-theme-previews/integrations/225787/):

Details

If I click "Resync webhook" I get "Webhook activation failed. Make sure you have the necessary permissions", which makes sense as I don't have admin permissions here.

---

@Mariatta Please can you try the "Resync webhook" button at https://readthedocs.org/dashboard/python-docs-theme-previews/integrations/225787/?

And is there anything at https://github.com/python/python-docs-theme/settings/hooks?

[hugovk]

Łukasz has enabled we hooks. 🎣

Close/re-open to retrigger...

[hugovk]

Deploy preview is now built!

Ready for review!

https://python-docs-theme-previews--105.org.readthedocs.build/en/105/