python / python/docs-community
Host the Python docs on ReadTheDocs
Personne n'a encore pris cette issue.
- Langage dominant
- Makefile
- Étoiles
- 55
- Forks
- 26
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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)
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner l’hébergement et le processus de build actuels de docs.python.org, puis comparez-les avec la configuration expérimentale de python.readthedocs.io. Portez une attention particulière à l’historique des versions, à Python 2.0 et aux autres anciennes versions, ainsi qu’à la charge de build indiquée pour plusieurs versions, langues et formats. La tâche sera considérée comme terminée lorsqu’un plan de migration concret préservera ces exigences et résoudra les compromis entre la PSF et l’hébergement.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100