Fix Sphinx docs build #386
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AetherUnbound
force-pushed
the
fix/make-docs
branch
from
71a71fa
to
ebf3085
Compare
AetherUnbound
approved these changes
Nov 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of Changes
Part of the upstream changes we pulled in added a dependency on recommonmark to add Markdown support for our Sphinx docs. Our docs build is currently failing because the recommonmark dependency wasn't added to our requirements.txt file as part of those changes.
Additionally, it looks like recommonmark is now deprecated and they recommend migrating to MyST.
This PR adds a dependency on MyST-Parser and configures Sphinx to use MyST.
Notes for Deployment
None!
Screenshots (if appropriate)
N/A
Tests and linting
Ran
just make-docs && just serve-docsand made sure docs still look as expectedI have rebased my changes on
mainjust lintpassesjust testpasses