sphinxcontrib-mermaid


Namesphinxcontrib-mermaid JSON
Version 0.9.2 PyPI version JSON
download
home_pagehttps://github.com/mgaitan/sphinxcontrib-mermaid
SummaryMermaid diagrams in yours Sphinx powered docs
upload_time2023-05-28 14:00:58
maintainer
docs_urlNone
authorMartín Gaitán
requires_python>=3.7
licenseBSD
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://github.com/mgaitan/sphinxcontrib-mermaid/actions/workflows/test.yml/badge.svg
    :target: https://github.com/mgaitan/sphinxcontrib-mermaid/actions/workflows/test.yml

.. image:: https://img.shields.io/pypi/v/sphinxcontrib-mermaid
   :target: https://pypi.org/project/sphinxcontrib-mermaid/

.. image:: https://img.shields.io/pypi/dm/shbin
   :target: https://libraries.io/pypi/sphinxcontrib-mermaid/


This extension allows you to embed `Mermaid <https://mermaid.js.org/>`_ graphs in your
documents, including general flowcharts, sequence diagrams, gantt diagrams and more.

It adds a directive to embed mermaid markup. For example::

  .. mermaid::

     sequenceDiagram
        participant Alice
        participant Bob
        Alice->John: Hello John, how are you?
        loop Healthcheck
            John->John: Fight against hypochondria
        end
        Note right of John: Rational thoughts <br/>prevail...
        John-->Alice: Great!
        John->Bob: How about you?
        Bob-->John: Jolly good!


By default, the HTML builder will simply render this as a ``div`` tag with
``class="mermaid"``, injecting the external javascript, css and initialization code to
make mermaid works.

For other builders (or if ``mermaid_output_format`` config variable is set differently), the extension
will use `mermaid-cli <https://github.com/mermaidjs/mermaid.cli>`_ to render as
to a PNG or SVG image, and then used in the proper code.




You can also embed external mermaid files, by giving the file name as an
argument to the directive and no additional content::

   .. mermaid:: path/to/mermaid-gantt-code.mmd

As for all file references in Sphinx, if the filename is not absolute, it is
taken as relative to the source directory.


In addition, you can use mermaid to automatically generate a diagram to show the class inheritance using the directive ``autoclasstree``. It accepts one or more fully qualified
names to a class or a module. In the case of a module, all the class found will be included.

Of course, these objects need to be importable to make its diagram.

If an optional attribute ``:full:`` is given, it will show the complete hierarchy of each class.

The option ``:namespace: <value>`` limits to the base classes that belongs to this namespace.
Meanwhile, the flag ``:strict:`` only process the classes that are strictly defined in the given
module (ignoring classes imported from other modules).


For example::

    .. autoclasstree:: sphinx.util.SphinxParallelError sphinx.util.ExtensionError
       :full:



Or directly the module::

    .. autoclasstree:: sphinx.util




Installation
------------

You can install it using pip

::

    pip install sphinxcontrib-mermaid

Then add ``sphinxcontrib.mermaid`` in ``extensions`` list of your project's ``conf.py``::

    extensions = [
        ...,
        'sphinxcontrib.mermaid'
    ]


Directive options
------------------

``:alt:``: determines the image's alternate text for HTML output.  If not given, the alternate text defaults to the mermaid code.

``:align:``: determines the image's position. Valid options are ``'left'``, ``'center'``, ``'right'``

``:caption:``: can be used to give a caption to the diagram.

``:zoom:``: can be used to enable zooming the diagram. For a global config see ``mermaid_d3_zoom``` bellow. 

.. figure:: https://user-images.githubusercontent.com/16781833/228022911-c26d1e01-7f71-4ab7-bb33-ce53056f8343.gif
   :align: center
   
   A preview after adding ``:zoom:`` option only to the first diagram example above:


Config values
-------------

``mermaid_output_format``

   The output format for Mermaid when building HTML files.  This must be either ``'raw'``
   ``'png'`` or ``'svg'``; the default is ``'raw'``. ``mermaid-cli`` is required if it's not ``raw``

``mermaid_version``

  The version of mermaid that will be used to parse ``raw`` output in HTML files. This should match a version available on https://unpkg.com/browse/mermaid/.  The default is ``"10.2.0"``. If you need a newer version, you'll need to add the custom initialization. See below. 

  If it's set to ``""``, the lib won't be automatically included from the CDN service and you'll need to add it as a local
  file in ``html_js_files``. For instance, if you download the lib to `_static/js/mermaid.js`, in ``conf.py``::


    html_js_files = [
       'js/mermaid.js',
    ]


``mermaid_init_js``

  Mermaid initilizaction code. Default to ``"mermaid.initialize({startOnLoad:true});"``.



``mermaid_cmd``

   The command name with which to invoke ``mermaid-cli`` program.  The default is ``'mmdc'``; you may need to set this to a full path if it's not in the executable search path.

``mermaid_cmd_shell``

   When set to true, the ``shell=True`` argument will be passed the process execution command.  This allows commands other than binary executables to be executed on Windows.  The default is false.

``mermaid_params``

   For individual parameters, a list of parameters can be added. Refer to `<https://github.com/mermaidjs/mermaid.cli#options>`_.
   Examples::

      mermaid_params = ['--theme', 'forest', '--width', '600', '--backgroundColor', 'transparent']

   This will render the mermaid diagram with theme forest, 600px width and transparent background.

``mermaid_sequence_config``

    Allows overriding the sequence diagram configuration. It could be useful to increase the width between actors. It **needs to be a json file**
    Check options in the `documentation <https://mermaid-js.github.io/mermaid/#/mermaidAPI?id=configuration>`_

``mermaid_verbose``

    Use the verbose mode when call mermaid-cli, and show its output in the building
    process.

``mermaid_pdfcrop``

    If using latex output, it might be useful to crop the pdf just to the needed space. For this, ``pdfcrop`` can be used.
    State binary name to use this extra function.

``mermaid_d3_zoom``

    Enables zooming in all the generated Mermaid diagrams.


Markdown support
----------------

You can include Mermaid diagrams in your Markdown documents in Sphinx.
You just need to setup the `markdown support in Sphinx <https://www.sphinx-doc.org/en/master/usage/markdown.html>`_ via
`myst-parser <https://myst-parser.readthedocs.io/>`_
. See a `minimal configuration from the tests <https://github.com/mgaitan/sphinxcontrib-mermaid/blob/master/tests/roots/test-markdown/conf.py>`_

Then in your `.md` documents include a code block as in reStructuredTexts::


 ```{mermaid}

     sequenceDiagram
       participant Alice
       participant Bob
       Alice->John: Hello John, how are you?
 ```

Building PDFs on readthedocs.io
-----------------------------------

In order to have Mermaid diagrams build properly in PDFs generated on readthedocs.io, you will need a few extra configurations.  

1. In your ``.readthedocs.yaml`` file (which should be in the root of your repository) include a ``post-install`` command to install the Mermaid CLI: ::

    build:
      os: ubuntu-20.04
      tools:
        python: "3.8"
        nodejs: "16"
      jobs:
        post_install:
          - npm install -g @mermaid-js/mermaid-cli

 Note that if you previously did not have a ``.readthedocs.yaml`` file, you will also need to specify all targets you wish to build and other basic configuration options.  A minimal example of a complete file is: ::

    # .readthedocs.yaml
    # Read the Docs configuration file
    # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

    # Required
    version: 2

    # Set the version of Python and other tools you might need
    build:
      os: ubuntu-20.04
      tools:
        python: "3.8"
        nodejs: "16"
      jobs:
        post_install:
          - npm install -g @mermaid-js/mermaid-cli

    # Build documentation in the docs/ directory with Sphinx
    sphinx:
       configuration: docs/conf.py

    # If using Sphinx, optionally build your docs in additional formats such as PDF
    formats:
      - epub
      - pdf

    python:
       install:
       - requirements: docs/requirements.txt

2. In your documentation directory add file ``puppeteer-config.json`` with contents: ::

    {
      "args": ["--no-sandbox"]
    }
   

3. In your documentation ``conf.py`` file, add: ::

    mermaid_params = ['-p' 'puppeteer-config.json']

Changelog
---------

0.9.2 (May 28, 2023)
+++++++++++++++++++++

- Implemented zoom on diagrams functionality. Contributed by `Daniel Althviz Moré <https://github.com/dalthviz>`_
- Fix a bug on empty diagram generations. Contributed by `Kevin Deldycke <https://github.com/kdeldycke>`_.  
- Upgrade default to Mermaid 10.2.0. 
- Implement automatic releases from Github Actions when a tag is pushed 

See full `set of changes <https://github.com/mgaitan/sphinxcontrib-mermaid/compare/0.9.2...0.8.1>`_.


0.8.1 (Feb 25, 2023)
+++++++++++++++++++++

- Default to Mermaid 9.4.0 as 10.0 introduced incompatible changes. 
  See `the discussion <https://github.com/mermaid-js/mermaid/discussions/4148>`_. 

0.8 (Feb 9, 2023)
+++++++++++++++++++++

- Moved CI to Github Actions
- Make the class diagram reproducible
- Allow the user to change the JS priority
- Drop support for Python 3.6
- Black formatting

See `full set of changes <https://github.com/mgaitan/sphinxcontrib-mermaid/compare/0.7.1...0.8>`_.


0.7.1 (July 17, 2021)
+++++++++++++++++++++

- Update docs and tests for markdown support


0.7 (May 31, 2021)
++++++++++++++++++++++++++

- Add compatibility with Sphinx 4.0
- `mermaid_init_js` is now included in an standard way.
- Documented how to use in Markdown documents


0.6.3 (February 21, 2021)
++++++++++++++++++++++++++

- Make it compatible with recent Sphinx versions
- Add basic (real) tests (So I stop breaking it!)


0.6.2 (February 18, 2021)
++++++++++++++++++++++++++

- fix regression
- setup travis


0.6.1 (February 8, 2021)
++++++++++++++++++++++++++

- Fix a problem when called mermaid-cli
- Fix typos on documentation
- Improve internal code formatting (via black)

0.6.0 (January 31, 2021)
++++++++++++++++++++++++++

- Drop support for Python version older than 3.6.
- Allow to include javascript lib locally
- Initialization code is now customizable
- The default version included from the CDN is always the latest available.


0.5.0 (September 24, 2020)
++++++++++++++++++++++++++

- Added mermaid_cmd_shell. Useful for Windows user.
- Reimplement inheritance diagrams.
- Fix UnicodeEncodeError on Python 2

0.4.0 (April 9, 2020)
+++++++++++++++++++++

- Added `mermaid_params`
- Added config file option
- Improved latex integration
- Added the `pdfcrop` functionality
- Mermaid version is configurable
- Several cleanups in the code


0.3.1 (Nov 22, 2017)
++++++++++++++++++++

- Support the new Mermaid CLI by `Bastian Luettig <https://github.com/bastiedotorg>`_


0.3 (Oct 4, 2017)
+++++++++++++++++++

- several improves and bugfixes contributed by `Alberto Berti <https://github.com/azazel75>`_

0.2.1 (Jun 4, 2017)
+++++++++++++++++++

-  Workaround for opacity issue with rtd's theme (thanks to `Anton
   Koldaev <http://github.com/iroller>`_)

0.2 (Jun 4, 2017)
+++++++++++++++++

-  Python 3 support fix (thanks to `Shakeeb
   Alireza <http://github.com/shakfu>`_)
-  In-browser diagram generation
-  Autoclasstree directive. (Thanks to
   `Zulko <http://github.com/zulko>`_)

0.1.1 (Jun 4, 2017)
+++++++++++++++++++

-  Better usage instructions
-  Bugfix

0.1 (Jul 18, 2016)
++++++++++++++++++

-  first public version

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mgaitan/sphinxcontrib-mermaid",
    "name": "sphinxcontrib-mermaid",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Mart\u00edn Gait\u00e1n",
    "author_email": "gaitan@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/8f/70/3d5664a7260a57b68f0b3ddcb29934b7888cbaf1577163e1db81bb9e42e2/sphinxcontrib-mermaid-0.9.2.tar.gz",
    "platform": "any",
    "description": ".. image:: https://github.com/mgaitan/sphinxcontrib-mermaid/actions/workflows/test.yml/badge.svg\n    :target: https://github.com/mgaitan/sphinxcontrib-mermaid/actions/workflows/test.yml\n\n.. image:: https://img.shields.io/pypi/v/sphinxcontrib-mermaid\n   :target: https://pypi.org/project/sphinxcontrib-mermaid/\n\n.. image:: https://img.shields.io/pypi/dm/shbin\n   :target: https://libraries.io/pypi/sphinxcontrib-mermaid/\n\n\nThis extension allows you to embed `Mermaid <https://mermaid.js.org/>`_ graphs in your\ndocuments, including general flowcharts, sequence diagrams, gantt diagrams and more.\n\nIt adds a directive to embed mermaid markup. For example::\n\n  .. mermaid::\n\n     sequenceDiagram\n        participant Alice\n        participant Bob\n        Alice->John: Hello John, how are you?\n        loop Healthcheck\n            John->John: Fight against hypochondria\n        end\n        Note right of John: Rational thoughts <br/>prevail...\n        John-->Alice: Great!\n        John->Bob: How about you?\n        Bob-->John: Jolly good!\n\n\nBy default, the HTML builder will simply render this as a ``div`` tag with\n``class=\"mermaid\"``, injecting the external javascript, css and initialization code to\nmake mermaid works.\n\nFor other builders (or if ``mermaid_output_format`` config variable is set differently), the extension\nwill use `mermaid-cli <https://github.com/mermaidjs/mermaid.cli>`_ to render as\nto a PNG or SVG image, and then used in the proper code.\n\n\n\n\nYou can also embed external mermaid files, by giving the file name as an\nargument to the directive and no additional content::\n\n   .. mermaid:: path/to/mermaid-gantt-code.mmd\n\nAs for all file references in Sphinx, if the filename is not absolute, it is\ntaken as relative to the source directory.\n\n\nIn addition, you can use mermaid to automatically generate a diagram to show the class inheritance using the directive ``autoclasstree``. It accepts one or more fully qualified\nnames to a class or a module. In the case of a module, all the class found will be included.\n\nOf course, these objects need to be importable to make its diagram.\n\nIf an optional attribute ``:full:`` is given, it will show the complete hierarchy of each class.\n\nThe option ``:namespace: <value>`` limits to the base classes that belongs to this namespace.\nMeanwhile, the flag ``:strict:`` only process the classes that are strictly defined in the given\nmodule (ignoring classes imported from other modules).\n\n\nFor example::\n\n    .. autoclasstree:: sphinx.util.SphinxParallelError sphinx.util.ExtensionError\n       :full:\n\n\n\nOr directly the module::\n\n    .. autoclasstree:: sphinx.util\n\n\n\n\nInstallation\n------------\n\nYou can install it using pip\n\n::\n\n    pip install sphinxcontrib-mermaid\n\nThen add ``sphinxcontrib.mermaid`` in ``extensions`` list of your project's ``conf.py``::\n\n    extensions = [\n        ...,\n        'sphinxcontrib.mermaid'\n    ]\n\n\nDirective options\n------------------\n\n``:alt:``: determines the image's alternate text for HTML output.  If not given, the alternate text defaults to the mermaid code.\n\n``:align:``: determines the image's position. Valid options are ``'left'``, ``'center'``, ``'right'``\n\n``:caption:``: can be used to give a caption to the diagram.\n\n``:zoom:``: can be used to enable zooming the diagram. For a global config see ``mermaid_d3_zoom``` bellow. \n\n.. figure:: https://user-images.githubusercontent.com/16781833/228022911-c26d1e01-7f71-4ab7-bb33-ce53056f8343.gif\n   :align: center\n   \n   A preview after adding ``:zoom:`` option only to the first diagram example above:\n\n\nConfig values\n-------------\n\n``mermaid_output_format``\n\n   The output format for Mermaid when building HTML files.  This must be either ``'raw'``\n   ``'png'`` or ``'svg'``; the default is ``'raw'``. ``mermaid-cli`` is required if it's not ``raw``\n\n``mermaid_version``\n\n  The version of mermaid that will be used to parse ``raw`` output in HTML files. This should match a version available on https://unpkg.com/browse/mermaid/.  The default is ``\"10.2.0\"``. If you need a newer version, you'll need to add the custom initialization. See below. \n\n  If it's set to ``\"\"``, the lib won't be automatically included from the CDN service and you'll need to add it as a local\n  file in ``html_js_files``. For instance, if you download the lib to `_static/js/mermaid.js`, in ``conf.py``::\n\n\n    html_js_files = [\n       'js/mermaid.js',\n    ]\n\n\n``mermaid_init_js``\n\n  Mermaid initilizaction code. Default to ``\"mermaid.initialize({startOnLoad:true});\"``.\n\n\n\n``mermaid_cmd``\n\n   The command name with which to invoke ``mermaid-cli`` program.  The default is ``'mmdc'``; you may need to set this to a full path if it's not in the executable search path.\n\n``mermaid_cmd_shell``\n\n   When set to true, the ``shell=True`` argument will be passed the process execution command.  This allows commands other than binary executables to be executed on Windows.  The default is false.\n\n``mermaid_params``\n\n   For individual parameters, a list of parameters can be added. Refer to `<https://github.com/mermaidjs/mermaid.cli#options>`_.\n   Examples::\n\n      mermaid_params = ['--theme', 'forest', '--width', '600', '--backgroundColor', 'transparent']\n\n   This will render the mermaid diagram with theme forest, 600px width and transparent background.\n\n``mermaid_sequence_config``\n\n    Allows overriding the sequence diagram configuration. It could be useful to increase the width between actors. It **needs to be a json file**\n    Check options in the `documentation <https://mermaid-js.github.io/mermaid/#/mermaidAPI?id=configuration>`_\n\n``mermaid_verbose``\n\n    Use the verbose mode when call mermaid-cli, and show its output in the building\n    process.\n\n``mermaid_pdfcrop``\n\n    If using latex output, it might be useful to crop the pdf just to the needed space. For this, ``pdfcrop`` can be used.\n    State binary name to use this extra function.\n\n``mermaid_d3_zoom``\n\n    Enables zooming in all the generated Mermaid diagrams.\n\n\nMarkdown support\n----------------\n\nYou can include Mermaid diagrams in your Markdown documents in Sphinx.\nYou just need to setup the `markdown support in Sphinx <https://www.sphinx-doc.org/en/master/usage/markdown.html>`_ via\n`myst-parser <https://myst-parser.readthedocs.io/>`_\n. See a `minimal configuration from the tests <https://github.com/mgaitan/sphinxcontrib-mermaid/blob/master/tests/roots/test-markdown/conf.py>`_\n\nThen in your `.md` documents include a code block as in reStructuredTexts::\n\n\n ```{mermaid}\n\n     sequenceDiagram\n       participant Alice\n       participant Bob\n       Alice->John: Hello John, how are you?\n ```\n\nBuilding PDFs on readthedocs.io\n-----------------------------------\n\nIn order to have Mermaid diagrams build properly in PDFs generated on readthedocs.io, you will need a few extra configurations.  \n\n1. In your ``.readthedocs.yaml`` file (which should be in the root of your repository) include a ``post-install`` command to install the Mermaid CLI: ::\n\n    build:\n      os: ubuntu-20.04\n      tools:\n        python: \"3.8\"\n        nodejs: \"16\"\n      jobs:\n        post_install:\n          - npm install -g @mermaid-js/mermaid-cli\n\n Note that if you previously did not have a ``.readthedocs.yaml`` file, you will also need to specify all targets you wish to build and other basic configuration options.  A minimal example of a complete file is: ::\n\n    # .readthedocs.yaml\n    # Read the Docs configuration file\n    # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details\n\n    # Required\n    version: 2\n\n    # Set the version of Python and other tools you might need\n    build:\n      os: ubuntu-20.04\n      tools:\n        python: \"3.8\"\n        nodejs: \"16\"\n      jobs:\n        post_install:\n          - npm install -g @mermaid-js/mermaid-cli\n\n    # Build documentation in the docs/ directory with Sphinx\n    sphinx:\n       configuration: docs/conf.py\n\n    # If using Sphinx, optionally build your docs in additional formats such as PDF\n    formats:\n      - epub\n      - pdf\n\n    python:\n       install:\n       - requirements: docs/requirements.txt\n\n2. In your documentation directory add file ``puppeteer-config.json`` with contents: ::\n\n    {\n      \"args\": [\"--no-sandbox\"]\n    }\n   \n\n3. In your documentation ``conf.py`` file, add: ::\n\n    mermaid_params = ['-p' 'puppeteer-config.json']\n\nChangelog\n---------\n\n0.9.2 (May 28, 2023)\n+++++++++++++++++++++\n\n- Implemented zoom on diagrams functionality. Contributed by `Daniel Althviz Mor\u00e9 <https://github.com/dalthviz>`_\n- Fix a bug on empty diagram generations. Contributed by `Kevin Deldycke <https://github.com/kdeldycke>`_.  \n- Upgrade default to Mermaid 10.2.0. \n- Implement automatic releases from Github Actions when a tag is pushed \n\nSee full `set of changes <https://github.com/mgaitan/sphinxcontrib-mermaid/compare/0.9.2...0.8.1>`_.\n\n\n0.8.1 (Feb 25, 2023)\n+++++++++++++++++++++\n\n- Default to Mermaid 9.4.0 as 10.0 introduced incompatible changes. \n  See `the discussion <https://github.com/mermaid-js/mermaid/discussions/4148>`_. \n\n0.8 (Feb 9, 2023)\n+++++++++++++++++++++\n\n- Moved CI to Github Actions\n- Make the class diagram reproducible\n- Allow the user to change the JS priority\n- Drop support for Python 3.6\n- Black formatting\n\nSee `full set of changes <https://github.com/mgaitan/sphinxcontrib-mermaid/compare/0.7.1...0.8>`_.\n\n\n0.7.1 (July 17, 2021)\n+++++++++++++++++++++\n\n- Update docs and tests for markdown support\n\n\n0.7 (May 31, 2021)\n++++++++++++++++++++++++++\n\n- Add compatibility with Sphinx 4.0\n- `mermaid_init_js` is now included in an standard way.\n- Documented how to use in Markdown documents\n\n\n0.6.3 (February 21, 2021)\n++++++++++++++++++++++++++\n\n- Make it compatible with recent Sphinx versions\n- Add basic (real) tests (So I stop breaking it!)\n\n\n0.6.2 (February 18, 2021)\n++++++++++++++++++++++++++\n\n- fix regression\n- setup travis\n\n\n0.6.1 (February 8, 2021)\n++++++++++++++++++++++++++\n\n- Fix a problem when called mermaid-cli\n- Fix typos on documentation\n- Improve internal code formatting (via black)\n\n0.6.0 (January 31, 2021)\n++++++++++++++++++++++++++\n\n- Drop support for Python version older than 3.6.\n- Allow to include javascript lib locally\n- Initialization code is now customizable\n- The default version included from the CDN is always the latest available.\n\n\n0.5.0 (September 24, 2020)\n++++++++++++++++++++++++++\n\n- Added mermaid_cmd_shell. Useful for Windows user.\n- Reimplement inheritance diagrams.\n- Fix UnicodeEncodeError on Python 2\n\n0.4.0 (April 9, 2020)\n+++++++++++++++++++++\n\n- Added `mermaid_params`\n- Added config file option\n- Improved latex integration\n- Added the `pdfcrop` functionality\n- Mermaid version is configurable\n- Several cleanups in the code\n\n\n0.3.1 (Nov 22, 2017)\n++++++++++++++++++++\n\n- Support the new Mermaid CLI by `Bastian Luettig <https://github.com/bastiedotorg>`_\n\n\n0.3 (Oct 4, 2017)\n+++++++++++++++++++\n\n- several improves and bugfixes contributed by `Alberto Berti <https://github.com/azazel75>`_\n\n0.2.1 (Jun 4, 2017)\n+++++++++++++++++++\n\n-  Workaround for opacity issue with rtd's theme (thanks to `Anton\n   Koldaev <http://github.com/iroller>`_)\n\n0.2 (Jun 4, 2017)\n+++++++++++++++++\n\n-  Python 3 support fix (thanks to `Shakeeb\n   Alireza <http://github.com/shakfu>`_)\n-  In-browser diagram generation\n-  Autoclasstree directive. (Thanks to\n   `Zulko <http://github.com/zulko>`_)\n\n0.1.1 (Jun 4, 2017)\n+++++++++++++++++++\n\n-  Better usage instructions\n-  Bugfix\n\n0.1 (Jul 18, 2016)\n++++++++++++++++++\n\n-  first public version\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "Mermaid diagrams in yours Sphinx powered docs",
    "version": "0.9.2",
    "project_urls": {
        "Download": "https://pypi.python.org/pypi/sphinxcontrib-mermaid",
        "Homepage": "https://github.com/mgaitan/sphinxcontrib-mermaid"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "711ee8b5c7536deba39eac1444c83d404374ed00c3a567445ba122249648a9fc",
                "md5": "e2377d847bed8596e81ec56e6b1cdbb5",
                "sha256": "6795a72037ca55e65663d2a2c1a043d636dc3d30d418e56dd6087d1459d98a5d"
            },
            "downloads": -1,
            "filename": "sphinxcontrib_mermaid-0.9.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e2377d847bed8596e81ec56e6b1cdbb5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 13453,
            "upload_time": "2023-05-28T14:00:56",
            "upload_time_iso_8601": "2023-05-28T14:00:56.514652Z",
            "url": "https://files.pythonhosted.org/packages/71/1e/e8b5c7536deba39eac1444c83d404374ed00c3a567445ba122249648a9fc/sphinxcontrib_mermaid-0.9.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8f703d5664a7260a57b68f0b3ddcb29934b7888cbaf1577163e1db81bb9e42e2",
                "md5": "2df3dd1811e764c84431835e6671eed2",
                "sha256": "252ef13dd23164b28f16d8b0205cf184b9d8e2b714a302274d9f59eb708e77af"
            },
            "downloads": -1,
            "filename": "sphinxcontrib-mermaid-0.9.2.tar.gz",
            "has_sig": false,
            "md5_digest": "2df3dd1811e764c84431835e6671eed2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 17909,
            "upload_time": "2023-05-28T14:00:58",
            "upload_time_iso_8601": "2023-05-28T14:00:58.147402Z",
            "url": "https://files.pythonhosted.org/packages/8f/70/3d5664a7260a57b68f0b3ddcb29934b7888cbaf1577163e1db81bb9e42e2/sphinxcontrib-mermaid-0.9.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-28 14:00:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mgaitan",
    "github_project": "sphinxcontrib-mermaid",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "sphinxcontrib-mermaid"
}
        
Elapsed time: 0.07319s