Documentation: pdf build of documentation
@dtembo1 is already working on this.
Since Oct 6, 2025.
- Dominant language
- Fortran
- Stars
- 263
- Forks
- 182
- Avg merge
- 11d 12h
- Merged PRs (30d)
- 7
Description
What's the issue?
📚 Please describe the problem you’ve noticed in the documentation.
Had a request for pdf version of the DART documentation. Not currently building pdf or epub.
Here is the current (v11.15) pdf version (see https://github.com/NCAR/DART/compare/main...rtd-pdf for the conf.py change to switch this on).
https://docs.dart.ucar.edu/_/downloads/en/rtd-pdf/pdf/
Where did you find the issue?
Provide the location(s) of the issue:
It is the contents/toc/chapter heading:
Sections in index.rst are chapters, then everything else (~1000 pages) is under the references. Here is the start and end of the table of contents:
.
.
.
.
.
What needs to be fixed?
Share what’s incorrect, unclear, missing, or outdated.
- Organization of documentation
- There are some (many?) links that are hardcoded to the html, so break in the pdf, e.g. the link will go to:
https://docs.dart.ucar.edu/_/downloads/en/filter/filter.html#DetailedProgramFlow
which does not exist. - various image formats don't work out of the box (gif, svn)
- The links to the dart tutorial do not work
- Some of the tables go off the page.
Also my sanity after setting up local build of latex pdf for readthedocs on mac.
Suggestions for improvement
I'm not sure of the demand for pdf/epub for the dart docs, but I think the organizing the current documentation for navigation is a worthwhile exercise.
Anything else we should know?
Include any other relevant details, such as references, screenshots, or related discussions.
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.
Assessment
This issue has not been assessed yet.