{
"info": {
"author": "Mart\u00edn Gait\u00e1n",
"author_email": "gaitan@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 4 - Beta",
"Environment :: Console",
"Environment :: Web Environment",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.3",
"Programming Language :: Python :: 3.4",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
"Topic :: Documentation",
"Topic :: Utilities"
],
"description": "This extension allows you to embed `Mermaid `_ graphs in your documents, including general flowcharts, sequence and gantt diagrams.\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
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 `_ to render as\nto a PNG or SVG image, and then used in the proper code.\n\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
prevail...\n John-->Alice: Great!\n John->Bob: How about you?\n Bob-->John: Jolly good!\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 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 inheritance of classes\nfor 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.\n\nFor example::\n\n\n .. autoclasstree:: sphinx.util sphinx\n\n\n.. autoclasstree:: sphinx.util sphinx\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 projec't ``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\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 Also note ``'svg'`` support is very experimental in mermaid.\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_phantom_path``\n\n PhantomJS (version ^1.9.0) to be installed and available in your $PATH, or you can specify it's location with in this config variable.\n\n\n``mermaid_sequence_config``\n\n Allows overriding the sequence diagram configuration. It could be useful to increase the width between actors. It **should be a normal python dictionary**\n Check options in the `documentation `_\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\nAcknowledge\n-----------\n\nMuch of the code is based on `sphinx.ext.graphviz `_. Thanks to its authors and other Sphinx contributors for such amazing tool.\n\n\nChangelog\n---------\n\n0.3.1 (Nov 22, 2017)\n+++++++++++++++++++\n\n- Support the new Mermaid CLI by `Bastian Luettig `_\n\n\n0.3 (Oct 4, 2017)\n+++++++++++++++++++\n\n- several improves and bugfixes contributed by `Alberto Berti `_\n\n0.2.1 (Jun 4, 2017)\n+++++++++++++++++++\n\n- Workaround for opacity issue with rtd's theme (thanks to `Anton\n Koldaev `_)\n\n0.2 (Jun 4, 2017)\n+++++++++++++++++\n\n- Python 3 support fix (thanks to `Shakeeb\n Alireza `_)\n- In-browser diagram generation\n- Autoclasstree directive. (Thanks to\n `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\n\n",
"description_content_type": null,
"docs_url": null,
"download_url": "https://pypi.python.org/pypi/sphinxcontrib-mermaid",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/mgaitan/sphinxcontrib-mermaid",
"keywords": "",
"license": "BSD",
"maintainer": "",
"maintainer_email": "",
"name": "sphinxcontrib-mermaid",
"package_url": "https://pypi.org/project/sphinxcontrib-mermaid/",
"platform": "any",
"project_url": "https://pypi.org/project/sphinxcontrib-mermaid/",
"project_urls": {
"Download": "https://pypi.python.org/pypi/sphinxcontrib-mermaid",
"Homepage": "https://github.com/mgaitan/sphinxcontrib-mermaid"
},
"release_url": "https://pypi.org/project/sphinxcontrib-mermaid/0.3.1/",
"requires_dist": null,
"requires_python": "",
"summary": "Mermaid diagrams in yours Sphinx powered docs",
"version": "0.3.1"
},
"last_serial": 3356160,
"releases": {
"0.1": [
{
"comment_text": "",
"digests": {
"md5": "b4e8704c009e29ab90f300778e23abc3",
"sha256": "c43511cbb176f1d9e4aa9ffc2ee5d7e7e6ccf936d09a9df5012e635116cc9c54"
},
"downloads": -1,
"filename": "sphinxcontrib_mermaid-0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "b4e8704c009e29ab90f300778e23abc3",
"packagetype": "bdist_wheel",
"python_version": "2.7",
"requires_python": null,
"size": 8804,
"upload_time": "2016-07-08T21:54:25",
"url": "https://files.pythonhosted.org/packages/72/42/9934e3a371ee5e12dd515ea81621c622db48891b8d1c4c9cf5ef283b4f49/sphinxcontrib_mermaid-0.1-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "70c00953373adc5aa64729df4fc9efae",
"sha256": "c7760324f80f63b73b7c09813c68a35bdf222b7a61dd36a72e9f4f5e2102daae"
},
"downloads": -1,
"filename": "sphinxcontrib-mermaid-0.1.tar.gz",
"has_sig": false,
"md5_digest": "70c00953373adc5aa64729df4fc9efae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6779,
"upload_time": "2016-07-08T21:54:49",
"url": "https://files.pythonhosted.org/packages/dd/df/bd312aacf0bb97557d16d074b8db0059666b56abbbf74beffa86c6e39acc/sphinxcontrib-mermaid-0.1.tar.gz"
}
],
"0.1.1": [
{
"comment_text": "",
"digests": {
"md5": "12f6c0b1c9dfcbb99e5a9cf0deca9bd9",
"sha256": "e63bf9caf8e58d87fb77b0ed43f44e19814ba76b4b8892771ee51f36b6ebb741"
},
"downloads": -1,
"filename": "sphinxcontrib_mermaid-0.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "12f6c0b1c9dfcbb99e5a9cf0deca9bd9",
"packagetype": "bdist_wheel",
"python_version": "2.7",
"requires_python": null,
"size": 9012,
"upload_time": "2016-07-08T22:01:44",
"url": "https://files.pythonhosted.org/packages/56/e6/279a8a2715771efd8644f92c8ba2b0ccb72282ee7870f5715f38042b0390/sphinxcontrib_mermaid-0.1.1-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "b4f95dd2a9636602a57dd52aa00976e5",
"sha256": "87ed3c52aecb8796824610df8a78d17e301dda3a4048c89958e47a703c23a786"
},
"downloads": -1,
"filename": "sphinxcontrib-mermaid-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "b4f95dd2a9636602a57dd52aa00976e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6854,
"upload_time": "2016-07-08T22:01:40",
"url": "https://files.pythonhosted.org/packages/a5/6d/560f954e8ac0540a414c0c0e61bf81975a82904ac5909e9f5565f2985002/sphinxcontrib-mermaid-0.1.1.tar.gz"
}
],
"0.2": [
{
"comment_text": "",
"digests": {
"md5": "a463a9b08b329eec361d09bff4b0a506",
"sha256": "7e9bbba1439a871a91b08f65ce69b75e60766f082acb9f3f0b3bd8fd96a4e78f"
},
"downloads": -1,
"filename": "sphinxcontrib_mermaid-0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "a463a9b08b329eec361d09bff4b0a506",
"packagetype": "bdist_wheel",
"python_version": "3.5",
"requires_python": null,
"size": 11051,
"upload_time": "2017-04-24T02:46:15",
"url": "https://files.pythonhosted.org/packages/b6/77/86838de8d0d3c93fcfb9052ec48738b47e7e23ad001fe9a1728cb0b3d44d/sphinxcontrib_mermaid-0.2-py2.py3-none-any.whl"
}
],
"0.2.1": [
{
"comment_text": "",
"digests": {
"md5": "ebac4f01c17c735fd6d355f61a97ac7d",
"sha256": "96f489baf9efe206311db5aa6a272db758eaba06e81dc8b02d9a683c291dda59"
},
"downloads": -1,
"filename": "sphinxcontrib_mermaid-0.2.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ebac4f01c17c735fd6d355f61a97ac7d",
"packagetype": "bdist_wheel",
"python_version": "3.5",
"requires_python": null,
"size": 11529,
"upload_time": "2017-06-04T03:56:35",
"url": "https://files.pythonhosted.org/packages/1e/0e/d99d12e4242c0938415f8b350f396ad68749b08e86dd4cd6db736a932566/sphinxcontrib_mermaid-0.2.1-py2.py3-none-any.whl"
}
],
"0.3": [
{
"comment_text": "",
"digests": {
"md5": "a070c6cb96cad56b5352d16748902277",
"sha256": "a9d44e853c7431cf547aa2648590f9bb8763b2c0f5d325c3513c1b89a4bb3fcb"
},
"downloads": -1,
"filename": "sphinxcontrib_mermaid-0.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "a070c6cb96cad56b5352d16748902277",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 11612,
"upload_time": "2017-10-04T17:16:52",
"url": "https://files.pythonhosted.org/packages/e1/5a/cd9d7b6353aef14f46b590aec76362ae1ea612af780d1ab2504b7f57faf3/sphinxcontrib_mermaid-0.3-py2.py3-none-any.whl"
}
],
"0.3.1": [
{
"comment_text": "",
"digests": {
"md5": "8aaa298b289d0d0a57444d752e68cb25",
"sha256": "d2e33529c63c12724193b210dcbd4285ca6cff17b8f91f9dbcb8b4b7d07595e7"
},
"downloads": -1,
"filename": "sphinxcontrib_mermaid-0.3.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "8aaa298b289d0d0a57444d752e68cb25",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 11816,
"upload_time": "2017-11-22T19:34:51",
"url": "https://files.pythonhosted.org/packages/b8/8d/3b3eaf71c03bea7308de8e646616e9536a44280d1250c642cbb87c118aba/sphinxcontrib_mermaid-0.3.1-py2.py3-none-any.whl"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "8aaa298b289d0d0a57444d752e68cb25",
"sha256": "d2e33529c63c12724193b210dcbd4285ca6cff17b8f91f9dbcb8b4b7d07595e7"
},
"downloads": -1,
"filename": "sphinxcontrib_mermaid-0.3.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "8aaa298b289d0d0a57444d752e68cb25",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 11816,
"upload_time": "2017-11-22T19:34:51",
"url": "https://files.pythonhosted.org/packages/b8/8d/3b3eaf71c03bea7308de8e646616e9536a44280d1250c642cbb87c118aba/sphinxcontrib_mermaid-0.3.1-py2.py3-none-any.whl"
}
]
}