Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the instructions for checking README syntax #2265

Merged
merged 2 commits into from
Dec 22, 2022
Merged

Update the instructions for checking README syntax #2265

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ecdcf02
Update the instructions for checking README syntax
maxrjones Dec 22, 2022
9919181
Merge branch 'main' into release-readme-checking
michaelgrund Dec 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions doc/maintenance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,14 +273,9 @@ publishing the actual release notes at https://www.pygmt.org/latest/changes.html
### 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:

```
rst2html.py --no-raw README.rst > index.html
```

Open `index.html` and check for any flaws or error messages.
To check the README syntax, visit the
[PyGMT TestPyPI release history](https://test.pypi.org/project/pygmt/#history), select
the latest commit, and review the left sidebar and project description for any errors.

### Pushing to PyPI and Updating the Documentation

Expand Down