Metadata-Version: 1.1
Name: sphinxcontrib-mermaid
Version: 0.3.1
Summary: Mermaid diagrams in yours Sphinx powered docs
Home-page: https://github.com/mgaitan/sphinxcontrib-mermaid
Author: Martín Gaitán
Author-email: gaitan@gmail.com
License: BSD
Download-URL: https://pypi.python.org/pypi/sphinxcontrib-mermaid
Description: This extension allows you to embed `Mermaid <http://knsv.github.io/mermaid/>`_ graphs in your documents, including general flowcharts, sequence and gantt diagrams.
        
        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.
        
        
        .. 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!
        
        
        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 absolute, it is
        taken as relative to the source directory.
        
        
        In addition, you can use mermaid to automatically generate a diagram to show the inheritance of classes
        for a given module using the directive ``autoclasstree``. This receive the module, and optionally the relative namespace. Obviously, the module need to be importable to be represented.
        
        For example::
        
        
            .. autoclasstree:: sphinx.util sphinx
        
        
        .. autoclasstree:: sphinx.util sphinx
        
        
        Installation
        ------------
        
        You can install it using pip
        
        ::
        
            pip install sphinxcontrib-mermaid
        
        Then add ``sphinxcontrib.mermaid`` in ``extensions`` list of your projec't ``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.
        
        
        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``
        
           Also note ``'svg'`` support is very experimental in mermaid.
        
        
        ``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_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://mermaidjs.github.io/sequenceDiagram.html#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.
        
        Acknowledge
        -----------
        
        Much of the code is based on `sphinx.ext.graphviz <http://www.sphinx-doc.org/en/stable/ext/graphviz.html>`_. Thanks to its authors and other Sphinx contributors for such amazing tool.
        
        
        Changelog
        ---------
        
        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
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
