Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Conflicts with other mermaid mkdocs plugins? #204

Unanswered
nfelt14 asked this question in Q&A
Discussion options

Does this plugin work with the https://github.com/fralau/mkdocs-mermaid2-plugin plugin when using the inheritance diagrams? Also, how does it play with the superfences feature of pymdownx?
You must be logged in to vote

Replies: 1 comment 19 replies

Comment options

It should work with this plugin, yes. Our inheritance diagrams are written as plain div elements with a mermaid class, which I believe the plugin supports. In fact, as long as the Mermaid.js script is included on the page, such divs will be processed by it, even without the plugin I believe.

Also, how does it play with the superfences feature of pymdownx?

Not sure what you mean by that, can you elaborate?
You must be logged in to vote
19 replies
Comment options

Oh, that was directly copy-pasted, so that is what the build creates
Comment options

Here is a new snippet:

<p class="doc doc-class-bases">
 Bases: <code><span title="tm_devices.driver_mixins.shared_implementations._tektronix_pi_afg_awg_mixin._TektronixPIAFGAWGMixin">_TektronixPIAFGAWGMixin</span></code>, <code><a class="autorefs autorefs-internal" href="../../../driver_mixins/device_control/pi_control/#tm_devices.driver_mixins.device_control.pi_control.PIControl" title="tm_devices.driver_mixins.device_control.PIControl">PIControl</a></code>, <code><a class="autorefs autorefs-internal" href="../../device/#tm_devices.drivers.device.Device" title="tm_devices.drivers.device.Device">Device</a></code>, <code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/abc.html#abc.ABC" title="abc.ABC">ABC</a></code></p>
<div style="display: none">
<a class="autorefs autorefs-internal" href="#tm_devices.drivers.afgs.afg.AFG" id="mermaid-link-tm_devices.drivers.afgs.afg.AFG"></a>
<a class="autorefs autorefs-internal" href="../../../driver_mixins/shared_implementations/common_pi_system_error_check_mixin/#tm_devices.driver_mixins.shared_implementations.common_pi_system_error_check_mixin.CommonPISystemErrorCheckMixin" id="mermaid-link-tm_devices.driver_mixins.shared_implementations.common_pi_system_error_check_mixin.CommonPISystemErrorCheckMixin"></a>
<a class="autorefs autorefs-internal" href="../../../driver_mixins/device_control/pi_control/#tm_devices.driver_mixins.device_control.pi_control.PIControl" id="mermaid-link-tm_devices.driver_mixins.device_control.pi_control.PIControl"></a>
<a class="autorefs autorefs-internal" href="../../device/#tm_devices.drivers.device.Device" id="mermaid-link-tm_devices.drivers.device.Device"></a>
<a class="autorefs autorefs-internal" href="../../../driver_mixins/abstract_device_functionality/signal_generator_mixin/#tm_devices.driver_mixins.abstract_device_functionality.signal_generator_mixin.SignalGeneratorMixin" id="mermaid-link-tm_devices.driver_mixins.abstract_device_functionality.signal_generator_mixin.SignalGeneratorMixin"></a>
</div>
<div class="mermaid" id="mermaid-diagram-tm_devices.drivers.afgs.afg.AFG">
 flowchart TD
 tm_devices.drivers.afgs.afg.AFG[AFG]
 tm_devices.driver_mixins.shared_implementations._tektronix_pi_afg_awg_mixin._TektronixPIAFGAWGMixin[_TektronixPIAFGAWGMixin]
 tm_devices.driver_mixins.shared_implementations.common_pi_system_error_check_mixin.CommonPISystemErrorCheckMixin[CommonPISystemErrorCheckMixin]
 tm_devices.driver_mixins.device_control.pi_control.PIControl[PIControl]
 tm_devices.driver_mixins.device_control._abstract_device_visa_write_query_control._AbstractDeviceVISAWriteQueryControl[_AbstractDeviceVISAWriteQueryControl]
 tm_devices.drivers.device.Device[Device]
 tm_devices.driver_mixins.device_control._abstract_device_control._AbstractDeviceControl[_AbstractDeviceControl]
 tm_devices.driver_mixins.abstract_device_functionality.signal_generator_mixin.SignalGeneratorMixin[SignalGeneratorMixin]
 tm_devices.driver_mixins.shared_implementations._extension_mixin._ExtendableMixin[_ExtendableMixin]
 tm_devices.driver_mixins.shared_implementations._tektronix_pi_afg_awg_mixin._TektronixPIAFGAWGMixin --&gt; tm_devices.drivers.afgs.afg.AFG
 tm_devices.driver_mixins.shared_implementations.common_pi_system_error_check_mixin.CommonPISystemErrorCheckMixin --&gt; tm_devices.driver_mixins.shared_implementations._tektronix_pi_afg_awg_mixin._TektronixPIAFGAWGMixin
 tm_devices.driver_mixins.device_control._abstract_device_visa_write_query_control._AbstractDeviceVISAWriteQueryControl --&gt; tm_devices.driver_mixins.shared_implementations.common_pi_system_error_check_mixin.CommonPISystemErrorCheckMixin
 tm_devices.driver_mixins.device_control._abstract_device_control._AbstractDeviceControl --&gt; tm_devices.driver_mixins.device_control._abstract_device_visa_write_query_control._AbstractDeviceVISAWriteQueryControl
 
 tm_devices.driver_mixins.abstract_device_functionality.signal_generator_mixin.SignalGeneratorMixin --&gt; tm_devices.driver_mixins.shared_implementations._tektronix_pi_afg_awg_mixin._TektronixPIAFGAWGMixin
 tm_devices.driver_mixins.shared_implementations._extension_mixin._ExtendableMixin --&gt; tm_devices.driver_mixins.abstract_device_functionality.signal_generator_mixin.SignalGeneratorMixin
 
 tm_devices.driver_mixins.shared_implementations._extension_mixin._ExtendableMixin --&gt; tm_devices.driver_mixins.shared_implementations._tektronix_pi_afg_awg_mixin._TektronixPIAFGAWGMixin
 
 tm_devices.driver_mixins.device_control.pi_control.PIControl --&gt; tm_devices.drivers.afgs.afg.AFG
 tm_devices.driver_mixins.device_control._abstract_device_visa_write_query_control._AbstractDeviceVISAWriteQueryControl --&gt; tm_devices.driver_mixins.device_control.pi_control.PIControl
 tm_devices.driver_mixins.device_control._abstract_device_control._AbstractDeviceControl --&gt; tm_devices.driver_mixins.device_control._abstract_device_visa_write_query_control._AbstractDeviceVISAWriteQueryControl
 
 tm_devices.driver_mixins.shared_implementations._extension_mixin._ExtendableMixin --&gt; tm_devices.driver_mixins.device_control.pi_control.PIControl
 
 tm_devices.drivers.device.Device --&gt; tm_devices.drivers.afgs.afg.AFG
 tm_devices.driver_mixins.device_control._abstract_device_control._AbstractDeviceControl --&gt; tm_devices.drivers.device.Device
 
 tm_devices.driver_mixins.shared_implementations._extension_mixin._ExtendableMixin --&gt; tm_devices.drivers.device.Device
 
 click tm_devices.drivers.afgs.afg.AFG href "" "tm_devices.drivers.afgs.afg.AFG"
 click tm_devices.driver_mixins.shared_implementations._tektronix_pi_afg_awg_mixin._TektronixPIAFGAWGMixin href "" "tm_devices.driver_mixins.shared_implementations._tektronix_pi_afg_awg_mixin._TektronixPIAFGAWGMixin"
 click tm_devices.driver_mixins.shared_implementations.common_pi_system_error_check_mixin.CommonPISystemErrorCheckMixin href "" "tm_devices.driver_mixins.shared_implementations.common_pi_system_error_check_mixin.CommonPISystemErrorCheckMixin"
 click tm_devices.driver_mixins.device_control.pi_control.PIControl href "" "tm_devices.driver_mixins.device_control.pi_control.PIControl"
 click tm_devices.driver_mixins.device_control._abstract_device_visa_write_query_control._AbstractDeviceVISAWriteQueryControl href "" "tm_devices.driver_mixins.device_control._abstract_device_visa_write_query_control._AbstractDeviceVISAWriteQueryControl"
 click tm_devices.drivers.device.Device href "" "tm_devices.drivers.device.Device"
 click tm_devices.driver_mixins.device_control._abstract_device_control._AbstractDeviceControl href "" "tm_devices.driver_mixins.device_control._abstract_device_control._AbstractDeviceControl"
 click tm_devices.driver_mixins.abstract_device_functionality.signal_generator_mixin.SignalGeneratorMixin href "" "tm_devices.driver_mixins.abstract_device_functionality.signal_generator_mixin.SignalGeneratorMixin"
 click tm_devices.driver_mixins.shared_implementations._extension_mixin._ExtendableMixin href "" "tm_devices.driver_mixins.shared_implementations._extension_mixin._ExtendableMixin"
 </div>
<script>
 var diagram = document.getElementById('mermaid-diagram-tm_devices.drivers.afgs.afg.AFG');
 diagram.innerHTML = diagram.innerHTML.replace(/click([\w.]+)href"""1円"/g, function(match, nodeID, offset) {
 const link = document.getElementById("mermaid-link-" + nodeID).href;
 return `click ${nodeID} href "${link}" "${nodeID}"`
 });
 </script>
<p>Base AFG device driver.</p>
Comment options

Thanks. So I think it can be fixed by catching errors when getting the link from the div above, in case it couldn't be rendered. I'll push a new version, but since you cannot update, can I send you the contents of the class.html.jinja template via email / matrix (since it's Insiders code)?
Comment options

That would be great. We are planning to drop support for Python 3.8 sometime in January, but the template will be useful to verify it works. I can just hold off on using it in production until we drop the 3.8 support.
Comment options

OK 🙂 If you want the template, just ping me somewhere (check out my GitHub profile)!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Category
Q&A
Labels
None yet
2 participants

AltStyle によって変換されたページ (->オリジナル) /