Personally, I prefer seeing a description on pypi -> and usually it's easy to re-use the README from GitHub and have it rendered on pypi as well. For example, see these lines in another package. You need to populate long_description
in setup.py
project_urls={
'Documentation': 'https://mne.tools/mne-bids',
'Bug Reports': 'https://github.com/mne-tools/mne-bids/issues',
'Source': 'https://github.com/mne-tools/mne-bids',
},
PS: You can also edit the GitHub "About" section to add the link to your documentation:
then users won't have to go through the README to find the link to the docs.