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

Switch to Plone Sphinx Theme for documentation, include changes to http-examples to build docs preview #1815

Merged
merged 11 commits into from
Sep 20, 2024

Conversation

stevepiercy
Copy link
Contributor

@stevepiercy stevepiercy commented Sep 18, 2024

  • Switch to Plone Sphinx Theme for documentation
  • The http-examples directory is now included for pull request previews.
  • I resynced the RTD webhook in this repo's settings as the PR preview builds were failing.

Closes #1097


📚 Documentation preview 📚: https://plonerestapi--1815.org.readthedocs.build/

@stevepiercy stevepiercy self-assigned this Sep 18, 2024
@mister-roboto
Copy link

@stevepiercy thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically.

Happy hacking!

@stevepiercy stevepiercy marked this pull request as draft September 18, 2024 19:34
@stevepiercy stevepiercy changed the title Include changes to http-examples to build docs preview Switch to Plone Sphinx Theme for documentation, include changes to http-examples to build docs preview Sep 19, 2024
@stevepiercy stevepiercy marked this pull request as ready for review September 19, 2024 10:22
@stevepiercy
Copy link
Contributor Author

@jenkins-plone-org please run jobs

@stevepiercy
Copy link
Contributor Author

There are two issues with the theme, which I can resolve in a future pull request, as this is an improvement.

  1. The tabs for http-examples have a white background in both light and dark mode, but should adapt.
  2. ScrollSpy is not working on the right-hand in-page navigation.

docs/source/conf.py Outdated Show resolved Hide resolved
@wesleybl
Copy link
Member

The tabs for http-examples have a white background in both light and dark mode, but should adapt.

This really looks weird, no contrast. It really needs to be fixed.

… obliterate the virtual environment. Most of the time, I just want to purge the built docs, not the virtual environment.
@stevepiercy
Copy link
Contributor Author

The tabs for http-examples have a white background in both light and dark mode, but should adapt.

This really looks weird, no contrast. It really needs to be fixed.

This should be fixed in PST 0.0.15. Preview: https://plonerestapi--1815.org.readthedocs.build/en/1815/endpoints/aliases.html#adding-new-url-aliases-for-a-page

@stevepiercy
Copy link
Contributor Author

The ScrollSpy bug is weird. Something in this repo interferes with it, as it is fine in the PST docs. If anyone can spy the issue, I'd appreciate the assist.

@stevepiercy
Copy link
Contributor Author

@jenkins-plone-org please run jobs

@stevepiercy
Copy link
Contributor Author

I'm not sure why the one Jenkins run fails, as this PR has nothing to do with its failing tests.

.github/workflows/tests.yml Show resolved Hide resolved
@davisagli davisagli merged commit dcf7966 into main Sep 20, 2024
24 of 25 checks passed
@davisagli davisagli deleted the rtd-improvements branch September 20, 2024 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Browser tiltle of documentation still says version 1.0a1
4 participants