# Mermaid support for Sphinx documentation
[Mermaid graphs](https://mermaid-js.github.io/mermaid/#/) support for [sphinx generated documentations](https://www.sphinx-doc.org/en/master/).
- [GitHub repository at Doreapp/sphinx-mermaid](https://github.com/Doreapp/sphinx-mermaid/)
- [Pypi package sphinx-mermaid](https://pypi.org/project/sphinx-mermaid/)
- Example of usage: [GitHub pages of this repo](https://doreapp.github.io/sphinx-mermaid/)
## Install
```bash
pip install sphinx-mermaid
```
## Setup in `conf.py`
In the `conf.py` file of your documentation, add the extension:
```python
extensions = [
...,
'sphinxmermaid'
]
```
## Usage
In your `rst` (or `md`) files, use the directive just like:
```rst
.. mermaid ::
graph TD
A --> B
B -- Label --> C
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Doreapp/sphinx-mermaid",
"name": "sphinx-mermaid",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "sphinxmermaid,mermaid,rst,reStructuredText,sphinx",
"author": "Antoine Mandin",
"author_email": "doreapp.contact@gmail.com",
"download_url": "",
"platform": null,
"description": "# Mermaid support for Sphinx documentation\n\n[Mermaid graphs](https://mermaid-js.github.io/mermaid/#/) support for [sphinx generated documentations](https://www.sphinx-doc.org/en/master/).\n\n- [GitHub repository at Doreapp/sphinx-mermaid](https://github.com/Doreapp/sphinx-mermaid/)\n- [Pypi package sphinx-mermaid](https://pypi.org/project/sphinx-mermaid/)\n- Example of usage: [GitHub pages of this repo](https://doreapp.github.io/sphinx-mermaid/)\n\n## Install\n\n```bash\npip install sphinx-mermaid\n```\n\n## Setup in `conf.py`\n\nIn the `conf.py` file of your documentation, add the extension:\n\n```python\nextensions = [\n ...,\n 'sphinxmermaid'\n]\n```\n\n## Usage\n\nIn your `rst` (or `md`) files, use the directive just like:\n\n```rst\n.. mermaid ::\n\n graph TD\n A --> B\n B -- Label --> C\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Mermaid graph support for sphinx generated documentations",
"version": "0.0.7",
"split_keywords": [
"sphinxmermaid",
"mermaid",
"rst",
"restructuredtext",
"sphinx"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "2ea1240562d36e1a673156626b49e8a3",
"sha256": "2bbb8b043d66a60f56eeeb081fd39ee5337d237ed5a685c0f27b544382408ca9"
},
"downloads": -1,
"filename": "sphinx_mermaid-0.0.7-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "2ea1240562d36e1a673156626b49e8a3",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 2839,
"upload_time": "2022-11-30T19:46:27",
"upload_time_iso_8601": "2022-11-30T19:46:27.509050Z",
"url": "https://files.pythonhosted.org/packages/ba/20/d55bef2d195a9d78b4187d5fbed5857d210e6037322f3bb0bddde647022d/sphinx_mermaid-0.0.7-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-11-30 19:46:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Doreapp",
"github_project": "sphinx-mermaid",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "sphinx",
"specs": []
}
],
"lcname": "sphinx-mermaid"
}
JSON
