readthedocs/sphinx_rtd_theme

Add documentation on how to extend the theme

Open

#582 aperta il 27 feb 2018

Vedi su GitHub
 (3 commenti) (2 reazioni) (0 assegnatari)CSS (1413 fork)batch import
Good First IssueNeeded: documentation

Metriche repository

Star
 (3473 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina la documentazione del tema Sphinx esistente e i blocchi template, quindi crea una guida su come estendere con CSS/JS e override dei template.
Tech stack
css
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
SphinxCSS
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80