lincc-frameworks / lincc-frameworks/python-project-template

RTD template: switch to sphinx_book_theme HTML theme

Ouverte
#519 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

enhancement
Langage dominant
Jinja
Étoiles
85
Forks
16
Merge moyen
6 h 18 min
PR mergées (30 j)
1

Description

sphinx_book_theme is used by hats/hats-import/lsdb/nested-pandas and it is really nice, let's use it for everything! It would probably help with #518 and #500

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par localiser la configuration de Read the Docs dans le template et consultez les issues #518 et #500 pour les exigences associées. Vérifiez comment le thème HTML actuel est sélectionné et mettez à jour le template afin que les projets générés utilisent sphinx_book_theme de manière cohérente ; le travail est terminé lorsque la documentation se construit avec le nouveau thème.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Domaine
documentation
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.