Different readmes for GitHub, PyPI and RTD

[felix-hilden]

Duplicating information is no good, and it leads to harder-to-maintain documentation. Having the most relevant information in correct places and linking between them could be a better strategy than just having one readme for all services surrounding the package.

Here's what I'm currently at. Each readme would include a short section with general information. It would be pretty much the same for every document. It would introduce spotipy and link to other services. It could also include a short example snippet of code. Then every readme would have some service-specific information.

GitHub

• Cloning the repository
• Running tests
• Building documentation
• Contributing

Read The Docs

• Features
• Getting started (with the Web API application as well)
• Documentation structure

PyPI

• Package info and history (all the relevant information regarding previous versions)
• How to install (possibly using different methods along with pip)

Maybe something else too.

[felix-hilden]

Waiting for transfer on PyPI and RTD for hyperlinks to be valid.

[SHxKM]

Has this occurred yet? any chance to see a readthedocs documentation site soon? Huge props for doing this!

[marioortizmanero]

Here's the issue where Felix requested the readthedocs site: readthedocs/readthedocs.org#6335

It should be resolved after Dec 19th, so there's still a bit left. PyPi support seems to be a bit stuck too: pypi/support#28

[felix-hilden]

@SHxKM Sadly no, as Mario pointed out. But do build the documentation yourself, it's a good resource! Have a look at the github readme for instructions if you didn't do it already.

[SHxKM]

Hmm, aren’t there many merits to just shipping this as a different package?

[felix-hilden]

Have a look at #22 and voice your opinion, I'd love to hear your thoughts as well. The discussion on that topic starts here.

[felix-hilden]

@SHxKM There is a temporary RTD site available now!

I also committed a future PyPI readme. Now the only thing left to do is update links when the name transfer issue is resolved.

[felix-hilden]

The initial release to PyPI has now been made and its readme is available there. Additionally a permanent RTD site is available as the package was renamed. I'll close this issue.