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

Add documentation pull request preview via Read the Docs #669

Closed
stevepiercy opened this issue Jun 30, 2024 · 4 comments · Fixed by #675
Closed

Add documentation pull request preview via Read the Docs #669

stevepiercy opened this issue Jun 30, 2024 · 4 comments · Fixed by #675

Comments

@stevepiercy
Copy link
Member

Do we have a docs pull request preview, such as that provided by Read the Docs? It would be good to verify that RFC links, API docs, and other markup renders correctly, without pulling down the branch and building the docs locally.

If not, we could copy what I did for plone-sphinx-theme. See also https://github.com/plone/plone-sphinx-theme/blob/main/.readthedocs.yaml#L13-L25 and https://github.com/plone/plone-sphinx-theme/blob/main/Makefile#L215-L217 for complete example.

Originally posted by @stevepiercy in #667 (comment)

@niccokunzmann
Copy link
Member

This sounds good to me!

@stevepiercy
Copy link
Member Author

stevepiercy commented Jun 30, 2024

@stevepiercy
Copy link
Member Author

@niccokunzmann would you please add me as a Maintainer for the RTD project? I am stevepiercy on RTD.

https://readthedocs.org/projects/icalendar/

Else please follow the instructions for How to configure pull request builds. Thank you!

@niccokunzmann
Copy link
Member

niccokunzmann commented Jul 1, 2024

@stevepiercy: Maintainer for the RTD project?

Done!
And I enables the checkbox for the PR build, too. Thanks for the link!

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 a pull request may close this issue.

2 participants