Skip to content

Commit

Permalink
Add pypa-compatible readme
Browse files Browse the repository at this point in the history
  • Loading branch information
timkpaine committed Oct 12, 2024
1 parent 55c56cc commit a153c4c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
10 changes: 10 additions & 0 deletions docs/readme_pypa.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# sphinxcontrib-mermaid

[![](https://github.com/mgaitan/sphinxcontrib-mermaid/actions/workflows/test.yml/badge.svg)](https://github.com/mgaitan/sphinxcontrib-mermaid/actions/workflows/test.yml)
[![](https://img.shields.io/pypi/v/sphinxcontrib-mermaid)](https://pypi.org/project/sphinxcontrib-mermaid/)
[![](https://img.shields.io/pypi/dm/shbin)](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.

See the [official Documentation](http://sphinxcontrib-mermaid-demo.readthedocs.io/en/latest/) or [project repository](https://github.com/mgaitan/sphinxcontrib-mermaid) for more details!
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ build-backend="setuptools.build_meta"
name = "sphinxcontrib-mermaid"
authors = [{name = "Martín Gaitán", email = "gaitan@gmail.com"}]
description="Mermaid diagrams in yours Sphinx powered docs"
readme = "README.rst"
readme = "docs/readme_pypa.md"
license = { text = "BSD" }
version = "1.0.0"
requires-python = ">=3.8"
Expand Down

0 comments on commit a153c4c

Please sign in to comment.