GenericMappingTools / GenericMappingTools/pygmt

Known issues in the PDF format of the PyGMT documentation

Open
#3,813 1 comment 0 reactions 0 assignees View on GitHub
help wanted longterm maintenance
Dominant language
Python
Stars
874
Forks
255
Avg merge
1d 21h
Merged PRs (30d)
40

Description

This is the central issue to report/discuss the issues in the PDF format of the PyGMT documentation. The PDF file for the dev version (reflecting the main branch) is available at https://www.pygmt.org/dev/pygmt-docs.pdf.

- [x] On the first page, it say 'Author name not set'. It would be nice if we could grab the names from the CITATION.cff file somehow. [Set to "The PyGMT Developers" in PR #3840]
- [ ] Missing emojis, unsure if there's anyway to show them in LaTeX (if it involves downloading a large font file, we can skip it)
![image](https://github.com/user-attachments/assets/8d5abc20-2950-4c42-be9d-4ccbed37849a)

- [ ] In the PDF file, the 'PyGMT Team' section lists everyone's profile pictures on 1 page (at a low-resolution). Unsure if there's a way to make those photos smaller.

_Originally posted by @weiji14 in https://github.com/GenericMappingTools/pygmt/pull/3765#pullrequestreview-2545575643_

- [x] Weird / confusing structure compared to the website. It looks like the sections of the README are used as chapter headings, and all sections on the website are listed under "Related topics", which is the last section of the README. [Fixed in #3840]

| website side bar | PDF contents |
| --- | --- |
| ![Image](https://github.com/user-attachments/assets/9a47dedf-a247-401c-9162-2178ac87a4e3) | ![Image](https://github.com/user-attachments/assets/fc26995d-672e-4b38-9b42-1db2e67a8779) |

- [ ] The content of `README.md` is not included [See the reason in #3840]

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.