llnl / llnl/smith

PDF generation in read the docs is failing

Open
#901 0 comments 0 reactions 0 assignees View on GitHub
bug bugfix day CI documentation
Dominant language
C++
Stars
245
Forks
36
Avg merge
8d 23h
Merged PRs (30d)
4

Description

Readthedocs recently turned on pdf generation failures disabling the entire doc build. This uncovered the fact that the pdf build is failing. I turned this off in `.readthedocs.yaml`, but we should investigate why this is happening. It looks like their pdf builder can't handle our math LaTeX commands.

Contributor guide

Open the contributing guide

Research direction

Start by inspecting `.readthedocs.yaml` and reproducing the Read the Docs PDF build. Investigate which math LaTeX commands cause the PDF builder to fail; done means PDF generation succeeds without disabling failure handling and the documentation build passes.

Written by the indexing model from the issue text.

Assessment

Tech stack
latex
Domain
build-system, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.