Skip to content

Render diagrams with Sphinx as Figures #3662

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 1 commit into from
Dec 18, 2024
Merged

Render diagrams with Sphinx as Figures #3662

merged 1 commit into from
Dec 18, 2024

Conversation

amolenaar
Copy link
Member

PR Type

What kind of change does this PR introduce?

  • Bug fix
  • Feature
  • Chore (refactoring, formatting, local variables, other cleanup)
  • Documentation content changes

What is the current behavior?

Diagrams are not easy to style. Small diagrams show up big in the documentation.

Issue Number: N/A

What is the new behavior?

Since images are wrapped in a figure, this also opens some (CSS) styling options.

This change also allows us to add a caption.

@amolenaar amolenaar added the feature A new feature label Dec 14, 2024
@amolenaar amolenaar requested a review from danyeaw December 14, 2024 14:12
@github-actions github-actions bot added python Pull requests that update Python code documentation labels Dec 14, 2024
This allows us to add a caption.
Since images are wrapped in a figure, this also opens some
(CSS) styling options.
Copy link
Member

@danyeaw danyeaw left a comment

Choose a reason for hiding this comment

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

Thanks!

@danyeaw danyeaw removed python Pull requests that update Python code documentation labels Dec 18, 2024
@danyeaw danyeaw changed the title Render diagrams with Sphinx as Figure Render diagrams with Sphinx as Figures Dec 18, 2024
@danyeaw danyeaw merged commit 827ffc7 into main Dec 18, 2024
23 checks passed
@danyeaw danyeaw deleted the sphinx-figure branch December 18, 2024 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature A new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants