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
|
2 days ago | |
|---|---|---|
| .github/workflows | 3 months ago | |
| readme_renderer | 3 days ago | |
| tests | 3 days ago | |
| .coveragerc | 8 years ago | |
| .gitignore | 4 years ago | |
| .gitpod.yml | 3 days ago | |
| CHANGES.rst | 3 months ago | |
| LICENSE | 8 years ago | |
| MANIFEST.in | 4 months ago | |
| README.rst | 2 days ago | |
| pyproject.toml | 3 days ago | |
| pytest.ini | 4 years ago | |
| setup.cfg | 1 year ago | |
| setup.py | 3 months ago | |
| tox.ini | 3 months ago | |
README.rst
Readme Renderer
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.htmlCode 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.