search

pradyunsg / furo

A clean customizable documentation theme for Sphinx
https://pradyunsg.me/furo/quickstart
MIT License
2.76k stars 317 forks source link

Support Sphinx 6.x #560

Closed marxin closed 1 year ago

marxin commented 2 years ago

Apparently the Furo template is not affected by removal of the JS libraries.

Fixes: #556.

pradyunsg commented 2 years ago

A few thoughts:

  1. I'd prefer to also drop 4.x support when adding 6.x support (and do the corresponding cleanup of dead code).
  2. This would need testing to ensure that Sphinx 6 + the docutils version it has, generate the right kind of markup.
  3. Sphinx 6 isn't stable yet, so I'm not particularly keen on allowing it (and potentially broken docs environments, that generate non-functional docs). If you want to eagerly play against that, I'd recommend using pip install in two steps -- first for Furo and then Sphinx 6.
marxin commented 2 years ago
  1. I'd prefer to also drop 4.x support when adding 6.x support (and do the corresponding cleanup of dead code).

All right. How can I identify the dead code (sphinx_version < 5)?

  1. This would need testing to ensure that Sphinx 6 + the docutils version it has, generate the right kind of markup.

I've just tried building my documentation with content="sphinx-6.0.0b3, furo 2022.09.29.dev1" and it looks fine (including search capability).

  1. Sphinx 6 isn't stable yet, so I'm not particularly keen on allowing it (and potentially broken docs environments, that generate non-functional docs). If you want to eagerly play against that, I'd recommend using pip install in two steps -- first for Furo and then Sphinx 6.

Well, on the other hand, that would allow people to test your template with Sphinx 6 and so potential issues will be addressed sooner than Sphinx 6.0 gets released.

marxin commented 2 years ago
  • This would need testing to ensure that Sphinx 6 + the docutils version it has, generate the right kind of markup.

I'm testing this for a week or so for the GCC converted documentation and it looks fine: https://splichal.eu/scripts/sphinx/gcc/_build/html/

pradyunsg commented 1 year ago

I just did this in https://github.com/pradyunsg/furo/commit/7f34478ece952918b5630a63dfaab0264bdf8fee, because I had completely forgotten that this PR was open. 🤦🏽

pradyunsg commented 1 year ago

Thanks for this PR @marxin! ^>^

marxin commented 1 year ago

Don't worry and thanks for it. Btw. can you please do a release?

pradyunsg commented 1 year ago

Yup, I'll try to cut one this week. :)