Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup read the docs #191

Merged
merged 4 commits into from
May 24, 2024
Merged

Setup read the docs #191

merged 4 commits into from
May 24, 2024

Conversation

ac-arcana
Copy link
Collaborator

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
Copy link
Collaborator Author

ac-arcana commented May 22, 2024

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
Copy link
Owner

@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
Copy link
Collaborator Author

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
Copy link
Owner

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 ac-arcana self-assigned this May 23, 2024
@ac-arcana
Copy link
Collaborator Author

I can't on my own PRs.

image

image

Copy link
Owner

@Phazorknight Phazorknight left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't on my own PRs.

Oops, wasn't aware of that.
I just approved this PR now without proper review to enable possible push to main.

@ac-arcana ac-arcana merged commit a01946a into Phazorknight:main May 24, 2024
1 check failed
@ac-arcana
Copy link
Collaborator Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants