wpilibsuite/wpilib-docs

Cleanup PDF Output

Aberta

#211 aberto em 28 de set. de 2019

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)JavaScript (297 forks)auto 404
Help Wantedbughacktoberfest-accepted

Métricas do repositório

Stars
 (187 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Investigue o pipeline de geração de PDF atual, focando na saída LaTeX do Sphinx. Identifique causas comuns de avisos na geração LaTeX, problemas de quebra de blocos de código e sobreposição de imagens. Proponha melhorias no template LaTeX ou na marcação rST para mitigar esses problemas.
Pilha de tecnologia
javascript
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
4
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
3-5 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
LaTeXreStructuredTextSphinxGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
55