search

jbms / sphinx-immaterial

Adaptation of the popular mkdocs-material material design theme to the sphinx documentation system
https://jbms.github.io/sphinx-immaterial/
Other
191 stars 29 forks source link

Fix 168 #174

Closed 2bndy5 closed 1 year ago

2bndy5 commented 1 year ago

resolves #168

This basically removes the commas from the substituted attributes ( triggered by xref attribute) and adds a couple unit tests to make sure the dot executable doesn't error out.

I have also visually verified that the graphs generated in the test are as expected. There might be a better way to inspect the SVG output, but I'd prefer to do that with a generated SVG file; this theme's graphviz ext embeds SVG data directly into the HTML for good reasons.

jbms commented 1 year ago

If you have other comma-separated attributes next to it, does it work to remove the commas?

jbms commented 1 year ago

If you have other comma-separated attributes next to it, does it work to remove the commas?

Nevermind, I see that commas are optional.

Looks good to me, thanks.

2bndy5 commented 1 year ago

Yeah, only the whitespace between attributes is important.

I'll merge this and tag main with v0.10 because the code annotations feature is taking me longer to polish than I had hoped.