Adding installation instructions to documentation #1403
Conversation
There was a problem hiding this comment.
I've made some comments.
Sidenote, @erikvansebille do you use sphinx-autobuild docs docs/_build for your docs local development? I'm getting an infinite rendering loop on my end, and just wondering if that's high enough priority for me to patch.
Co-authored-by: Vecko <36369090+VeckoTheGecko@users.noreply.github.com>
Co-authored-by: Vecko <36369090+VeckoTheGecko@users.noreply.github.com>
Co-authored-by: Vecko <36369090+VeckoTheGecko@users.noreply.github.com>
Co-authored-by: Vecko <36369090+VeckoTheGecko@users.noreply.github.com>
Co-authored-by: Vecko <36369090+VeckoTheGecko@users.noreply.github.com>
|
Tanks for these comments, @VeckoTheGecko! Really useful! Especially the fact that
No, I don't use sphinx-auto build myself. Am doing manual building for now. |
Removing suggestion to change $PYTHONPATH
Removing the 'double-block' for code in a list, that seems to be a bug in sphinx-docs? Now also more control on the numbering of items Also updating some of the texts
Fixed ordering. May have been misinterpreted before as "cd into the `parcels` folder in the `parcels` repo", as opposed to "cd into the `parcels` repo"
Now that the tutorials are all on readthedocs, it makes sense to also move the installation instructions there. In this PR, I created an RST version of the installation instructions at https://oceanparcels.org/#installing, and also considerably cleaned them up / simplified them