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 164 #177

Closed 2bndy5 closed 1 year ago

2bndy5 commented 1 year ago

resolves #164

Implementation requires the manually specified label attribute be ~immediately~ after the xref attribute. I didn't add any unit tests because the docs demonstrate the purpose without fail, but we can add tests for certain graph types or use cases as we come across them.

jbms commented 1 year ago

It looks like graphviz allows an attribute such as label to be specified more than once in a given scope, with only the last value being used. So I don't think we actually need any special code to handle this --- the user can just specify label afterwards and it will override the label set from xref.

2bndy5 commented 1 year ago

It looks like graphviz allows an attribute such as label to be specified more than once in a given scope.

If so, then only the doc updates should be sufficient here. I'll do some testing and change this accordingly.

2bndy5 commented 1 year ago

It looks like graphviz allows an attribute such as label to be specified more than once in a given scope.

This is correct, so I reverted the changes to the ext, and proofread the doc changes. I wish I knew this when I opened #164. At least it is now documented.

jbms commented 1 year ago

Thanks. Looks good to me.