Add instructions to generate the documentation locally

jean-zay-users / jean-zay-doc

Collaborative documentation for and from Jean Zay users. Official Jean Zay documentation: http://www.idris.fr/eng/jean-zay/

https://jean-zay-doc.readthedocs.io/en/latest/

MIT License

106 stars 34 forks source link

Add instructions to generate the documentation locally #77

Closed lesteve closed 2 years ago

mdiazmel commented 2 years ago

I don't know if it matters but maybe we can also remember to the contributors that instead of building locally a built version of each PR is available in https://jean-zay-doc--[#PR].org.readthedocs.build/en/[#PR]/. For example, for this PR, the corresponding version of the documentation is in https://jean-zay-doc--77.org.readthedocs.build/en/77/

Up to you if you want to include this information, otherwise we can merge it.

lesteve commented 2 years ago

Done, to see how it is rendered by github: https://github.com/jean-zay-users/jean-zay-doc/blob/f0f275ddfbeaafa0e300e8ea9e5c55885c38939b/README.md