integrate Nightwatch with readthedocs

Question

integrate Nightwatch with readthedocs

Closed this issue a year ago · 8 comments

Set up a readthedocs page for Nightwatch to document the software and various bits of setup needed to maintain it at KPNO and NERSC. Caution should be used to avoid posting any sensitive information about access to the DESI machines.

Answer 1 · 2024-01-21T16:27:30.000Z

The documentation skeleton is set up (see #373). The last step requires a readthedocs webhook to be enabled for generating the docs. Presumably @sbailey or @weaverba137 need to do this.

Answer 2 · 2024-01-22T16:42:36.000Z

I can take care of this. If for some reason nightwatch.readthedocs.io is already taken, I'll use desi-nightwatch.readthedocs.io. This follows the pattern of desi-specter.readthedocs.io.

Answer 3 · 2024-01-22T17:05:26.000Z

Actually, I take that back. https://nightwatch.readthedocs.io/ already exists and @sybenzvi is the maintainer. That means that @sybenzvi has to set up the webhook.

Answer 4 · 2024-01-22T19:21:04.000Z

@weaverba137, thanks for checking into this. I should have clarified that I was able to set up a readthedocs site for Nightwatch but I don't have admin access in desihub to change package settings. Specifically, I don't see the usual Settings "gear" icon that lets me access the GitHub menu to set up webhooks, and in readthedocs.io I have a warning message indicating I don't have the proper GitHub permissions.

You could give me admin permission in desihub or maybe just desihub/nightwatch. That's probably less work for you, assuming you are willing to trust me with that.

Or I could send you the link from the readthedocs integration settings (and maybe the secret key too) and you enter the values into the GitHub webhooks setup dialog.

Let me know which you prefer.

Answer 5 · 2024-01-22T20:33:58.000Z

Thank you @sybenzvi, that makes more sense. I think the best way to proceed would be to add me as a maintainer of nightwatch in the ReadTheDocs system. My ReadTheDocs username is the same as my GitHub username.

Answer 6 · 2024-01-22T21:35:51.000Z

@weaverba137, I added you as a Nightwatch maintainer in readthedocs. I agree this is a more sustainable solution; it's better to have more than one maintainer. Check your email for the invitation link.

Answer 7 · 2024-01-22T21:38:32.000Z

OK, I think the webhook is synchronized now. If you make any changes in the near future, make sure those are reflected on ReadTheDocs.

Answer 8 · 2024-01-22T21:53:23.000Z

Thanks @weaverba137, I confirm that merges with main automatically initiate a build on readthedocs.