Copie de page pour test
Sur GitHub
Dépôt du fichier
Commencez par déposer votre fichier .rst :
- Sur GitHubdans docs/source/
Dans le sommaire
Dans le fichier index.rst, pensez à ajouter votre page au sommaire :
.. toctree::
tuto_page
//Ajouter ici le nom de votre fichier ('calvados' pour 'calvados.rst' par exemple).
Note
Comme pout tout travail sur GitHub, ce commit est aussi réalisable en ligne de commande depuis un git local. Vous ne savez pas comment faire ? Récupérez le fichier « … » sur le dépôt.
Une fois les changements effectués et enregistrés sur le dépôt GitHub, la compilation de la doc se lance automatiquement dans ReadTheDocs.
Sur ReadTheDocs
Allez sur la page de votre projet de documentation. Dans l’onglet “Compilations”, vous pouvez suivre l’avancée de la compilation de votre dernier commit GitHub.
Si la compilation est réussie, la page de documentation sera mise à jour après quelques minutes (pensez à actualiser) !