Check for pdflatex PDF build (it only runs on RTD after merge on main)
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 171
- Forks
- 75
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 20
Description
Overview:
-
Read The Docs builds PDFs for the website
-
The PDF build is somewhat fiddly, so Read The Docs does not do it on PR previews
-
This leads to a seemingly good PR not merging on RTD (see #571 and #590 for reference)
This is the broken build: https://app.readthedocs.org/projects/ngff/builds/34222546/
It would be useful to have a check for the built PDF too. However, the needed LaTex dependencies are large and configuring the whole thing felt error-prone. We could spend more time debugging the checker than actually using it.
If this bites again, we can evaluate the need. Before that, it is perhaps most useful just knowing that this can happen (build ok on GitHub but red on Read The Docs) .
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the broken Read the Docs build at https://app.readthedocs.org/projects/ngff/builds/34222546/ and compare the referenced issues #571 and #590. Determine whether a PDF check is practical despite the LaTeX dependency size; done means a clear decision and, if pursued, validation before a PR merges.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- latex
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100