Investigate ReadTheDocs to ease documentation readability
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 16
- Forks
- 15
- Merge moyen
- 1 j 9 h
- PR mergées (30 j)
- 10
Description
Is there an existing issue for this?
- I have searched the existing issues.
Please describe the feature you have in mind and explain what the current shortcomings are?
This work needs to be approved first.
From a discussion with @dee-ynput and @mkolar it looks like readthedocs (theme and/or platform) might be beneficial for the automated API docs generated through Sphinx.
This could be investigated to assess the benefit/concerns.
How would you imagine the implementation of the feature?
No precise idea yet, it could be simply use the ReadTheDocs theme with sphinx or bringing more in order to get versioning feature automatically there for free.
We need to see if everything can remain on GitHub pages in order to not multiplying the host platforms tho..
Are there any labels you wish to add?
- I have added the relevant labels to the enhancement request.
Describe alternatives you've considered:
No response
Additional context:
No response
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
Aucun fichier ni test n’est nommé. Commencez par examiner comment la documentation d’API générée par Sphinx est actuellement publiée sur GitHub Pages, puis étudiez le thème et la plateforme ReadTheDocs, notamment les compromis liés à la gestion des versions et à l’hébergement ; le travail est considéré comme terminé lorsque les avantages, les points de préoccupation et une recommandation pour approbation sont documentés.
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