Lisez la documentation des hôtes Docs pour la communauté open source. Il prend en charge de nombreux outils de documentation (par exemple les documents Sphinx écrits avec reStructuredText, les documents MkDocs écrits avec markdown, entre autres) et peut extraire des référentiels Git. Ensuite, nous construisons la documentation et l’hébergeons pour vous. Considérez-le comme une documentation continue ou Docs as Code.
Vous trouverez une documentation complète pour la mise en place de votre projet sur le site Read the Docs.
Vous pouvez trouver des informations pour contacter Read the Docs sur notre page de contribution.
Vous pouvez trouver des informations sur la contribution à Read the Docs sur notre page de contribution.
À la fin de ce démarrage rapide, vous aurez un nouveau projet automatiquement mis à jour lorsque vous le pousserez vers GitHub.
Créez un compte sur Read the Docs en vous inscrivant sur GitHub.
Lorsque vous y êtes invité sur GitHub, donnez accès à votre compte.
Connectez-vous et cliquez sur "Ajouter un projet".
Commencez à taper le nom de votre référentiel, sélectionnez-le dans la liste, puis cliquez sur "Continuer".
Modifiez les informations si vous le souhaitez et cliquez sur "Suivant".
Tout est fait. Engagez-vous et votre projet sera automatiquement mis à jour.
MIT © 2010 Read the Docs, Inc. et contributeurs