wpilibsuite/wpilib-docs

Cleanup PDF Output

Aperta

#211 aperta il 28 set 2019

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)JavaScript (297 fork)auto 404
Help Wantedbughacktoberfest-accepted

Metriche repository

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

Descrizione

I think the PDF output can be improved in a number of ways

  • Reduce/Remove the amount of warnings in generation
  • Code blocks can sometimes break weirdly in PDF generation
  • Images will sometimes span over text

Note: While PDF and EPUB are generated, I wouldn't exactly call them supported. I personally think this is just a nice feature to have in addition. This issue requires intimate knowledge on how LaTeX works, as well as how it retrieves content from rST. If major changes are required to the existing document structure, it'll be evaluated if it's worth it or not.

Thanks for anyone willing to take on this issue :)

Guida contributor

Direzione di ricerca
Investiga la pipeline di generazione PDF attuale, concentrandoti sull'output LaTeX da Sphinx. Identifica le cause comuni degli avvisi nella generazione LaTeX, i problemi di interruzione dei blocchi di codice e la sovrapposizione delle immagini. Proponi miglioramenti al template LaTeX o al markup rST per mitigare questi problemi.
Tech stack
javascript
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
4
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
3-5 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
LaTeXreStructuredTextSphinxGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
55