Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Eliminate PDF from the 6.0 build and packaging #805

Closed
PaulWessel opened this issue May 30, 2019 · 7 comments
Closed

Eliminate PDF from the 6.0 build and packaging #805

PaulWessel opened this issue May 30, 2019 · 7 comments

Comments

@PaulWessel
Copy link
Member

PDF documentation is a legacy from the past when we printed stuff. Now it is a limitation since not everything that can be done in HTML translate to PDF. It also adds bulk to the tarballs, etc.

The proposals is to remove all vestiges of PDF from the documentation and the CMake/build scripts. Looking for comments from @GenericMappingTools/core here.

@seisman
Copy link
Member

seisman commented May 30, 2019

PDF documentation is a legacy from the past when we printed stuff.

As far as I know, there are still many users who prefer PDF documentations (printed or electronic), especially for people with slow internet connections.

Now it is a limitation since not everything that can be done in HTML translate to PDF.

Agree. We can focus on the HTML version, but at least should provide a PDF one.

It also adds bulk to the tarballs, etc.

GMT_Docs.pdf, GMT_Tutorials.pdf, GMT_API.pdf aren't included into the tarballs, right?

@joa-quim
Copy link
Member

It would be nice that build docs didn't build by default the pdf versions of the figs nor the docs. As is, I always have to remember to delete all pdf's from the build dir before creating the Win installers.

@seisman
Copy link
Member

seisman commented May 30, 2019

It would be nice that build docs didn't build by default the pdf versions of the figs nor the docs. As is, I always have to remember to delete all pdf's from the build dir before creating the Win installers.

Currently, make docs_depends always generate both PNG and PDF formats, which are used in HTML and PDF documentations, respectively. Maybe we can split docs_depends target into docs_html_depends and docs_pdf_depends.

@PaulWessel
Copy link
Member Author

Yes, that is a good starting point. It probably bogs down the CI to make both sets.

@seisman
Copy link
Member

seisman commented Aug 6, 2019

I remember we have decided to drop PDF documentations in the summit. Is it true? If so, I can make a PR to cleanup the PDF build.

@PaulWessel
Copy link
Member Author

Yes, we decided to drop the PDF docs from 6.0.0 but retain then in 5.4.x in case we release an update. Not sure if we will though.

@seisman
Copy link
Member

seisman commented Aug 6, 2019

Closed by #1312.

@seisman seisman closed this as completed Aug 6, 2019
obaney pushed a commit to obaney/gmt that referenced this issue Aug 18, 2021
We have these linting issues because base_plotting.py is too long:

```
pygmt/base_plotting.py:1:0: C0302: Too many lines in module (2047/2000) (too-many-lines)
```

The problem will be fixed in GenericMappingTools#685, but it may take some time.
This PR increases the max-module-lines to 3000 to temporarily disable the warning.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants