Enable the PDF format documentation in the ReadTheDocs site #2876
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
seisman
changed the title
seisman
added
maintenance
yvonnefroehlich
approved these changes
Dec 13, 2023
seisman
added
final review call
michaelgrund
approved these changes
Dec 14, 2023
seisman
changed the title
seisman
changed the title
seisman
changed the title
seisman
removed
the
final review call
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
This PR enables the PDF documentation in the ReadTheDocs builds. This is the initial and simple effort to address the request in #1606.
After merging the changes into the main branch (PDFs are disabled in PR previews), we will see a PDF download link at the bottom of the sidebar on the ReadTheDocs site (https://pygmt-dev.readthedocs.io/), as shown below:
The screenshot above comes from the PyGMT documentation site built from my own PyGMT fork. The full URL of the site is https://pygmt-test.readthedocs.io/en/latest/, and the direct URL of PDF file is https://pygmt-test.readthedocs.io/_/downloads/en/latest/pdf/.
As you can see, the layout of the PDF documentation is not ideal, but at least it includes everything, and is still useful for offline use.
If approved and merged, I think we should post the link to the PDF documentation in issue #1606 so that users can easily find the PDF file.