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

docs: use Sphinx 8 #1303

Merged
merged 3 commits into from
Aug 20, 2024
Merged

docs: use Sphinx 8 #1303

merged 3 commits into from
Aug 20, 2024

Conversation

dimaqq
Copy link
Contributor

@dimaqq dimaqq commented Jul 31, 2024

Edit: re-locked with Sphinx 8 now that furo supports it.

@benhoyt
Copy link
Collaborator

benhoyt commented Jul 31, 2024

Would it make sense just to wait till we can use Sphinx 8, to avoid busy-work? In the meantime, we could relax 6.2.1 to 6.x.

@dimaqq
Copy link
Contributor Author

dimaqq commented Aug 1, 2024

6.2.1 is the latest 6.x release, and Sphinx 6.x is no longer supported. In fact they rejected my bug report wrt. py 3.12.4.

@dimaqq
Copy link
Contributor Author

dimaqq commented Aug 19, 2024

I'll try to update this to Sphinx 8.

@IronCore864
Copy link
Contributor

Looks nice, it seems nothing changed, which is good though!

@dimaqq
Copy link
Contributor Author

dimaqq commented Aug 19, 2024

Nothing broke visually

https://pianomister.github.io/diffsite/?url1=https%3A%2F%2Fops--1303.org.readthedocs.build%2Fen%2F1303%2F&url2=https%3A%2F%2Fops.readthedocs.io%2Fen%2Flatest%2F

The only real difference detected by tooling is that inline code spans are 1px off, but I can't see this with my own eye.

The search behaviour is different:

  • ops.readthedocs.io: 7 hits for "pebble", seems to search only text
  • this branch: 240 hits, listing every ops.pebble.This and that.

@dimaqq dimaqq requested a review from benhoyt August 19, 2024 00:39
@dimaqq dimaqq marked this pull request as ready for review August 19, 2024 00:39
@dimaqq dimaqq changed the title docs: use newer Sphinx docs: use Sphinx 8 Aug 19, 2024
@dimaqq
Copy link
Contributor Author

dimaqq commented Aug 19, 2024

rebased on latest main, just in case

@tonyandrewmeyer
Copy link
Contributor

  • ops.readthedocs.io: 7 hits for "pebble", seems to search only text
  • this branch: 240 hits, listing every ops.pebble.This and that.

This is much better. For example, a while back we had a complaint about searching for "secret" not providing useful results, which was true. Now it gives you the most obvious result first and lots of other good ones afterwards.

Copy link
Collaborator

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

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

Ah yes, search is much better, thanks!

pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
@dimaqq dimaqq merged commit 7a5513a into canonical:main Aug 20, 2024
32 checks passed
@dimaqq dimaqq deleted the docs-newer-sphinx branch August 20, 2024 06:07
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.

4 participants