Skip to content

Commit

Permalink
Remove command-line example from readme
Browse files Browse the repository at this point in the history
This doesn't currently support Markdown and is confusing to users who don't fully read it.
  • Loading branch information
di authored and miketheman committed Aug 20, 2022
1 parent d853780 commit 2f92e6f
Showing 1 changed file with 0 additions and 8 deletions.
8 changes: 0 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,6 @@ 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
---------------

Expand Down

0 comments on commit 2f92e6f

Please sign in to comment.