wpilibsuite/wpilib-docs

Cleanup PDF Output

Open

#211 opened on Sep 28, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (297 forks)auto 404
Help Wantedbughacktoberfest-accepted

Repository metrics

Stars
 (187 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Investigate the current PDF generation pipeline, focusing on LaTeX output from Sphinx. Identify common causes of warnings in LaTeX generation, code block breaking issues, and image overlap. Propose improvements to the LaTeX template or rST markup to mitigate these issues.
Tech stack
javascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
LaTeXreStructuredTextSphinxGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55