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.

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

Add sphinxcontrib-drawio #24

Open
BrentK-ADI opened this issue Dec 16, 2024 · 1 comment
Open

Add sphinxcontrib-drawio #24

BrentK-ADI opened this issue Dec 16, 2024 · 1 comment

Comments

@BrentK-ADI
Copy link

Add support for draw.io drawings directly, versus needing to export to an image file.

@gastmaier
Copy link
Contributor

gastmaier commented Dec 18, 2024

Hi! is there any issue with the sphinxcontrib.drawio enabled with doctools?
In general, you can add third-party extensions to the list on extensions at conf.py

I only discourage using extensions that render content on the client side using JavaScript, like wavedrom, because it:

  • requires fetching third-party scripts (most of the times).
  • makes exporting to other formats (like pdf) harder, because you have to patch and replace with another solution.

I see that https://pypi.org/project/sphinxcontrib-drawio/ calls drawio executable (JavaScript + Electron) (https://github.com/jgraph/drawio), so make sure to set up the environment during the CI also.

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

No branches or pull requests

2 participants