wpilibsuite/wpilib-docs

Cleanup PDF Output

Ouverte

#211 ouverte le 28 sept. 2019

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)JavaScript (297 forks)auto 404
Help Wantedbughacktoberfest-accepted

Métriques du dépôt

Stars
 (187 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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 :)

Guide contributeur

Direction de recherche
Enquétez sur le pipeline actuel de génération de PDF, en vous concentrant sur la sortie LaTeX de Sphinx. Identifiez les causes courantes des avertissements dans la génération LaTeX, les problèmes de rupture des blocs de code et le chevauchement des images. Proposez des améliorations au modèle LaTeX ou au balisage rST pour atténuer ces problèmes.
Stack technique
javascript
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.
4
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
3-5 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
LaTeXreStructuredTextSphinxGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
55