Lesen Sie die Docs-Hosts-Dokumentation für die Open-Source-Community. Es unterstützt viele Dokumentationstools (z. B. mit reStructuredText geschriebene Sphinx-Dokumente, mit Markdown geschriebene MkDocs-Dokumente usw.) und kann Git-Repositorys abrufen. Anschließend erstellen wir die Dokumentation und hosten sie für Sie. Betrachten Sie es als kontinuierliche Dokumentation oder Dokumente als Code.
Eine vollständige Dokumentation zum Einrichten Ihres Projekts finden Sie auf der Website „Read the Docs“.
Informationen zur Kontaktaufnahme mit Read the Docs finden Sie auf unserer Beitragsseite.
Informationen zum Mitwirken an „Read the Docs“ finden Sie auf unserer Beitragsseite.
Am Ende dieser Schnellstartanleitung wird ein neues Projekt automatisch aktualisiert, wenn Sie es auf GitHub übertragen.
Erstellen Sie ein Konto bei Read the Docs, indem Sie sich bei GitHub anmelden.
Wenn Sie auf GitHub dazu aufgefordert werden, gewähren Sie Zugriff auf Ihr Konto.
Loggen Sie sich ein und klicken Sie auf „Projekt hinzufügen“.
Beginnen Sie mit der Eingabe des Namens Ihres Repositorys, wählen Sie es aus der Liste aus und klicken Sie auf „Weiter“.
Ändern Sie bei Bedarf alle Informationen und klicken Sie auf „Weiter“.
Alles erledigt. Legen Sie los und Ihr Projekt wird automatisch aktualisiert.
MIT © 2010 Read the Docs, Inc. und Mitwirkende