Phazorknight / Cogito

Immersive Sim Template Project for GODOT 4
MIT License
670 stars 72 forks source link

Setup read the docs #191

Closed ac-arcana closed 1 month ago

ac-arcana commented 2 months ago

Please don't merge this yet. Apparently Read The Docs can compile documentation from pull requests. I am just setting up a config file here and I'd like to try to set up some docs and see how it goes before proposing to merge this.

ac-arcana commented 1 month ago

Okay so for Read the Docs I've run into a snag. Normally it would automatically configure the repo to allow Read the Docs to function, but because I don't own the repo I don't have enough permissions to do that. It requires a web hook.

The manual instructions for setup are: image

@Phazorknight, would you like to try setting this webhook up? Alternatively you might be able to set up Read the Docs yourself and it would auto configure. If this is all too inconvenient/too much work for what you feel are unneeded features then I would accept that answer as well.

Edit: As the webhook is set up correctly, I have removed the url and secret from this post.

Phazorknight commented 1 month ago

@Phazorknight, would you like to try setting this webhook up?

Ok, i just added the Webhook and it seems like the ping was successful.

ac-arcana commented 1 month ago

Thank you for adding it. I'm still getting some errors form setup. Mainly that I don't have a .readthedocs.yaml set up, even though I do in this PR. Maybe it has to be in the main and can't just read from the PR, despite the ability for it to build docs from PRs...

Phazorknight commented 1 month ago

Might be something that trips up ReadTheDocs on the initial setup. With your new permissions you should be able to push stuff to main now though, shouldn't you?

ac-arcana commented 1 month ago

I can't on my own PRs.

image

image

ac-arcana commented 1 month ago

Okay so I was able to merge this. Almost there with getting this setup. I just forgot some quotes in the .readthedocs.yaml file.