Skip to content

Update Sphinx, Theming, and Faster Builds #1354

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

Merged
merged 17 commits into from
Jul 24, 2023

Conversation

vector-of-bool
Copy link
Contributor

This changeset does a few things:

  1. Sphinx is now updated to 7.0.1
  2. The vendored theme has been removed, and documentation is now generated with Furo
  3. Generated documentation uses the dirhtml Sphinx builder. This generates "prettier" URLs by placing every page within its own directory with a single index.html inside. The result is that URLs no longer have a .html suffix.
  4. To keep old links working, the old .html files are generated and just redirect to the new URLs.
  5. The "man pages hack" that we were using was breaking parallel builds in Sphinx. This hack has been replaced with a less-janky hack that works with parallel builds.

Other than the above, the documentation content has remained unchanged. Future changes will include documentation content updates. The rendered results of these changes are available in the make-docs tasks in EVG.

Copy link
Contributor

@eramongodb eramongodb left a comment

Choose a reason for hiding this comment

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

Exciting changes! Minor feedback; otherwise LGTM.

@vector-of-bool vector-of-bool removed the request for review from rcsanchez97 July 24, 2023 18:53
Copy link
Collaborator

@kevinAlbs kevinAlbs left a comment

Choose a reason for hiding this comment

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

LGTM. I like the new documentation theme. And the parallel build is much appreciated.

@vector-of-bool vector-of-bool merged commit ba5ab6d into mongodb:master Jul 24, 2023
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