You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Mike Fiedler d821b44664
docs: add badges to README (#243)
2 days ago
.github/workflows chore: drop support for python 3.6 (#236) 3 months ago
readme_renderer feat: allow admonitions to be rendered (#242) 3 days ago
tests feat: allow admonitions to be rendered (#242) 3 days ago
.coveragerc Initial commit 8 years ago
.gitignore Ignore PyCharm (JetBrains) metadata 4 years ago
.gitpod.yml feat(dev): enable gitpod development (#238) 3 days ago
CHANGES.rst Release 35.0 (#237) 3 months ago
LICENSE Initial commit 8 years ago
MANIFEST.in chore: add types (#225) 4 months ago
README.rst docs: add badges to README (#243) 2 days ago
pyproject.toml feat(dev): enable gitpod development (#238) 3 days ago
pytest.ini Warn about markdown content type when checking RST (#83) 4 years ago
setup.cfg Set python_requires in setup.py and stop building universal wheels. 1 year ago
setup.py test: update html attribute order (#235) 3 months ago
tox.ini chore: drop support for python 3.6 (#236) 3 months ago

README.rst

Readme Renderer

image

image

Readme Renderer is a library that will safely render arbitrary README files into HTML. It is designed to be used in Warehouse to render the long_description for packages. It can handle Markdown, reStructuredText (.rst), and plain text.

Check Description Locally

To locally check whether your long descriptions will render on PyPI, first build your distributions, and then use the twine check_ command.

Render rST Description Locally

You can use readme_renderer on the command line to render an rST file as HTML like this: :

python -m readme_renderer README.rst -o /tmp/README.html

Code of Conduct

Everyone interacting in the readme_renderer project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PSF Code of Conduct.