Write documentation about Sphinx docs

[FilippoOggionni]

No description provided.

[FilippoOggionni]

Pages to review:

• release versioning, especially bumpversion (link)
• sphinx for local documentation (link)
• readthedocs for online documentation and versioning (link)

Waiting for a review from @DominicDirkx @gaffarelj @geoffreygarrett 😃

[gaffarelj]

Thanks for these, they will be very useful! :)

One global comment to start with: could you activate the code snippet copy button for the developer docs? Or if you want I can look into it instead.

Release versioning
Everything is clear to me. As we discussed on Slack, adding a note about how to add git tags in PyCharm/VS Code/Terminal would be welcomed.

Sphinx documentation
Great overall, a few minor comments:

1. I don't know why there is this command at the beginning of the page: sudo apt-get install texmaker gummi texlive texlive-full texlive-latex-recommended latexdraw intltool-debian lacheck libgtksourceview2.0-0 libgtksourceview2.0-common lmodern luatex po-debconf tex-common texlive-binaries texlive-extra-utils texlive-latex-base texlive-latex-base-doc texlive-luatex texlive-xetex texlive-lang-cyrillic texlive-fonts-extra texlive-science texlive-latex-extra texlive-pstricks
2. In the first note, it would be nice to have "Getting Started with Conda" as a link.
3. Point 1: "This can be done by downloading this environment.yaml (yaml)," I think the environment.yaml (yaml) indicated a link that is messed up. I would suggest just having environment.yaml as a link directly.
4. For the following tip: [PyCharm/CLion] You can do this in by right clicking index.html in the Project tree and selecting Open with Browser.: I would personally indicate how users can do so directly in Windows or OSX instead. This feels more general. (For windows, right click, open with, select preferred browser).
5. For the No changes shown in browser troubleshooting. Clearing the entire browser cache is quite overkill, and would annoy quite a lot of people (since you get disconnected from some services at the same time, and need to download every webpage again from scratch). Instead, temporarily disabling the cache may be best, using the wev developer tools. Look here for instance for Chrome (=new Edge) and Firefox.
6. For the "No changes shown in online docs" troubleshooting: most likely, this is caused by the cache again. I would first refer to the first troubleshooting point.
7. In the same troubleshooting step: "link in the readthedocs_menu_ (see screenshot above)". The screenshot is actually below, and the link appears to be broken.

Release an online version

1. 3. test the build locally (see Sphinx Documentation) it would be nice to have a link again (for consistency).
2. 4. update the CHANGELOG.md if I am not mistaken, it's actually CHANGELOG.rst.
3. I don't know why, all the screenshots appear in an incredibly low resolution for me (but when I open the images they are okay).
4. I think linking the troubleshooting from this page to the ones of Sphinx documentation would be more efficient.

[DominicDirkx]

@FilippoOggionni Once you process all the detailed comments from @gaffarelj, post here and I'll do a second round of reviews