Skip to content

Update to Sphinx 7.0 & enable parallell builds#891

Merged
dgarcia360 merged 14 commits intomasterfrom
update-sphinx-7
Oct 6, 2023
Merged

Update to Sphinx 7.0 & enable parallell builds#891
dgarcia360 merged 14 commits intomasterfrom
update-sphinx-7

Conversation

@dgarcia360
Copy link
Copy Markdown
Collaborator

@dgarcia360 dgarcia360 commented Sep 15, 2023

Related issue #887 and #860

  • Update to Sphinx 7
  • Update min Python 3.9
  • Enable parallel builds
  • Fix RemovedInSphinx80Warning: Sphinx 8 will drop support for representing paths as strings. Use "pathlib.Path" or "os.fspath" instead warnings.
  • backport feat: skip lfs smudge #890
  • Fix tests
  • Bump multiversion version
  • Test against sphinx-scylladb-theme repo
  • Test against scylla opensource repo
  • Run linter

How to test

  1. Build the docs.
  2. Check that ther are not errors.
  3. Check that the footer shows Sphinx 7.0.x

@dgarcia360 dgarcia360 changed the title Update to Sphinx 7.0 Update to Sphinx 7.0 & enable parallell builds Sep 26, 2023
@tzach
Copy link
Copy Markdown
Collaborator

tzach commented Sep 26, 2023

@dgarcia360 it would be nice to test how much this PR improve doc build time for a a project like scylladb/scylladb

@dgarcia360
Copy link
Copy Markdown
Collaborator Author

dgarcia360 commented Sep 28, 2023

@tzach Definitely! I will share metrics if the doc build time improves.

@dgarcia360
Copy link
Copy Markdown
Collaborator Author

Sphinx 7.0 + parallel builds has not reduced significantly the build time for the open-source project - the bottleneck still is in the sidebar generation.

@annastuchlik
Copy link
Copy Markdown
Collaborator

@dgarcia360 Looks good, no errors. I can see Sphinx 7.2 in the footer.
image

@dgarcia360 dgarcia360 merged commit e9cdcc8 into master Oct 6, 2023
@dgarcia360 dgarcia360 deleted the update-sphinx-7 branch October 6, 2023 12:48
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.

3 participants