python / python/docs-community
Host the Python docs on ReadTheDocs
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Makefile
- Sterne
- 55
- Forks
- 26
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
From time to time the discussion arise about moving docs.python.org to readthedocs, there's even an experimental python.readthedocs.io.
I think there's many pros and cons of using readthedocs.
I'd personally be in favor of it if we (the PSF) support them (the cpython Doc is a big one with a lot of traffic, it take around 24h of CPU to build all versions × languages with all PDF A4, PDF letter, HTML, plaintext, epub).
In the other hand it's not an easy task, among other things docs.python.org is not only about generating the docs but also hosting history:
- https://docs.python.org/release/ (this is all the tagged commits in the cpython repo)
- https://docs.python.org/2.0/ (yes we keep old versions, and I'm not willing to see this disapear)
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
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 mit einer Prüfung des aktuellen Hostings und Build-Prozesses von docs.python.org und vergleiche ihn anschließend mit dem experimentellen Setup von python.readthedocs.io. Achte besonders auf die Release-Historie, Python 2.0 und andere alte Versionen sowie auf die angegebene Build-Last durch mehrere Versionen, Sprachen und Formate. Als abgeschlossen gilt die Aufgabe, wenn ein konkreter Migrationsplan vorliegt, der diese Anforderungen beibehält und die Zielkonflikte zwischen PSF und Hosting löst.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100