Skip to content

Commit

Permalink
Instructions for checking the RST in the README
Browse files Browse the repository at this point in the history
PyPI is not very forgiving of slight problems with the README rst code.
  • Loading branch information
leouieda committed Sep 13, 2018
1 parent c7daebe commit b8d9ba9
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions MAINTENANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,18 @@ There are a few steps that still must be done manually, though.
5. Add a link to the new release version documentation in `README.rst`.
5. Open a new PR with the updated changelog.

### Check the README syntax

Github is a bit forgiving when it comes to the RST syntax in the README but PyPI is not.
So slightly broken RST can cause the PyPI page to not render the correct content. Check
using the `rst2html.py` script that comes with docutils:

```
python setup.py --long-description | rst2html.py --no-raw > index.html
```
Open `index.html` and check for any flaws or error messages.
### Pushing to PyPI and updating the documentation
After the changelog is updated, making a release should be as simple as creating a new
Expand Down

0 comments on commit b8d9ba9

Please sign in to comment.