python / python/docs-community

Host the Python docs on ReadTheDocs

Aperta
#5 40 commenti 4 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

discussion
Lingua principale
Makefile
Stelle
55
Fork
26
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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:

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando l’hosting e il processo di build attuali di docs.python.org, quindi confrontali con la configurazione sperimentale di python.readthedocs.io. Presta particolare attenzione alla cronologia delle release, a Python 2.0 e alle altre versioni meno recenti, nonché al carico di build indicato per più versioni, lingue e formati. Il lavoro sarà considerato completato quando sarà disponibile un piano di migrazione concreto che preservi tali requisiti e risolva i compromessi tra PSF e hosting.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.