[mkdocs] - rebuild docs automatically on update
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 18.3k
- Forks
- 2k
- Ø Merge
- 2 T. 12 Std.
- Gemergte PRs (30 T.)
- 28
Beschreibung
One of the benefits of our current docs for contributors if you are working on a doc and make some change to an example or some text, jekyll rebuilds the documentation automatically and you can see the change in your browser.
With how mkdocs is implemented on the live-docs branch you need to stop the mkdocs server, rebuild the docs using make examples and then restart the server (mkdocs serve)
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne auf dem Branch live-docs damit zu überprüfen, wie make examples und mkdocs serve derzeit verwendet werden. Verfolge den Ablauf des Dokumentations-Neuaufbaus und vergleiche ihn mit dem beschriebenen Jekyll-Verhalten; fertig ist die Aufgabe, wenn Änderungen an Beispielen oder Texten im Browser erscheinen, ohne den Server manuell stoppen, neu aufbauen und neu starten zu müssen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- build-system, documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100