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.

Sign up for GitHub

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

Jump to bottom

Stop parsing from overwriting Sphinx configuration #422

Merged
merged 4 commits into from Jan 26, 2024
Merged

Stop parsing from overwriting Sphinx configuration #422

merged 4 commits into from Jan 26, 2024

Conversation

flying-sheep
Copy link
Contributor

@flying-sheep flying-sheep commented Jan 26, 2024 •
edited

Fixes #421, fixes scverse/scanpy#2829

This PR introduces a parse function that abstracts away the instantiation and use of a RSTParser instance.

It uses the sphinx.util.docutils:sphinx_domains context manager to make sure that the docutils directive and role registries are managed properly.

@flying-sheep flying-sheep changed the title Fix parsing Stop parsing from overwriting Sphinx configuration Jan 26, 2024
gaborbernat
gaborbernat requested changes Jan 26, 2024
View reviewed changes
Copy link
Member

@gaborbernat gaborbernat left a comment

Choose a reason for hiding this comment

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

Let's add a test for this case 👍

gaborbernat
gaborbernat approved these changes Jan 26, 2024
View reviewed changes
Copy link
Member

@gaborbernat gaborbernat left a comment

Choose a reason for hiding this comment

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

@gaborbernat gaborbernat merged commit d2955c6 into tox-dev:main Jan 26, 2024
10 checks passed
@flying-sheep flying-sheep deleted the fix-parse branch January 26, 2024 15:55
@flying-sheep
Copy link
Contributor Author

Thanks, that was quick!

@g3n35i5 g3n35i5 mentioned this pull request Feb 8, 2024
Open
@alexdlaird alexdlaird mentioned this pull request Mar 10, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gaborbernat gaborbernat gaborbernat approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

s-a-t breaks default_role in parameter descriptions Parameter docs render text in backticks as <cite/> text
2 participants
@flying-sheep @gaborbernat