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

Support Sphinx 6.x #560

Merged
merged 1 commit into from
Nov 7, 2022
Merged

Support Sphinx 6.x #560

merged 1 commit into from
Nov 7, 2022

Conversation

marxin
Copy link
Contributor

@marxin marxin commented Oct 18, 2022

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

Fixes: #556.

@pradyunsg
Copy link
Owner

pradyunsg commented Oct 18, 2022

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.

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

Fixes: pradyunsg#556.
@marxin
Copy link
Contributor Author

marxin commented Oct 18, 2022

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

marxin commented Oct 24, 2022

  • 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 pradyunsg merged commit 646275c into pradyunsg:main Nov 7, 2022
@pradyunsg
Copy link
Owner

pradyunsg commented Nov 7, 2022

I just did this in 7f34478, because I had completely forgotten that this PR was open. 🤦🏽

@pradyunsg
Copy link
Owner

Thanks for this PR @marxin! ^>^

@marxin marxin deleted the sphinx-6 branch November 7, 2022 07:17
@marxin
Copy link
Contributor Author

marxin commented Nov 7, 2022

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

@pradyunsg
Copy link
Owner

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

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.

None yet

2 participants