readthedocs/sphinx_rtd_theme

Add documentation on how to extend the theme

Open

#582 ouverte le 27 févr. 2018

Voir sur GitHub
 (3 commentaires) (2 réactions) (0 assignés)CSS (1 413 forks)batch import
Good First IssueNeeded: documentation

Métriques du dépôt

Stars
 (3 473 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

This is something that I get questions on a lot:

  • New maintainers want to know how to add CSS/JS. We prescribe adding in a setup() extension point via app.add_stylesheet() to get around our extension
  • Companies doing a deeper conversion of our theme to match their brand should know how to extend our templates
  • Our template blocks should be documented some? Or at least we point to the Sphinx default list of blocks that we emulate

Guide contributeur

Direction de recherche
Examinez la documentation existante du theme Sphinx et les blocs de templates, puis creez un guide sur la facon d'etendre avec CSS/JS et les surcharges de templates.
Stack technique
css
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
SphinxCSS
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80