openPMD/openPMD-api

Sphinx: C++/Py Side-By-Side

Aperta

#62 aperta il 13 feb 2018

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)C++ (57 fork)auto 404
documentationgood first issuehelp wanted

Metriche repository

Star
 (160 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

We should add a little CSS hack in docs/source/_static/ that layouts directly following C++ and Python code blocks side-by-side.

Depends on

  • #32

Guida contributor

Direzione di ricerca
Crea la documentazione localmente con Sphinx. Esamina il CSS esistente in docs/source/ static/. Comprendi come vengono generati i blocchi di codice e aggiungi una regola CSS per visualizzare i blocchi di codice C++ e Python adiacenti fianco a fianco.
Tech stack
css
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Bloccata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitCSSSphinx
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75