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

Add documentation for downloading #7114

Closed
ynikitenko opened this issue Apr 25, 2023 · 6 comments · Fixed by #7116
Closed

Add documentation for downloading #7114

ynikitenko opened this issue Apr 25, 2023 · 6 comments · Fixed by #7116

Comments

@ynikitenko
Copy link

What did you do?

I was trying to download Pillow documentation. I visited Pillow site, then ReadTheDocs, then I could not download the documentation in one link.

What did you expect to happen?

I expected that there will be pdf or at least zipped html for downloading.

What actually happened?

On ReadTheDocs the downloads section was empty.

What are your OS, Python and Pillow versions?

  • OS: Arch Linux.
  • Python: yes.
  • Pillow: yes. From PyPI, I believe.
@radarhere radarhere changed the title add documentation for downloading Add documentation for downloading Apr 25, 2023
@radarhere
Copy link
Member

I've created PR #7116 to resolve this.

For the moment, here is a PDF, zipped HTML and (zipped, GitHub wouldn't allow it otherwise) EPUB of our last release -
stable.pdf, html.zip and epub.zip.

@ynikitenko
Copy link
Author

Thank you very much! I've already downloaded docs using wget, but it takes more time and effort (and a pdf is always nice).

@radarhere
Copy link
Member

@ynikitenko any thoughts on #7116 (comment)?

This nearly doubles docs build times from ~137s to ~230s.

Do we need all four build formats? PDF was the preferred format in #7114, is default + PDF enough to begin with?

@ynikitenko
Copy link
Author

@radarhere oh, yes. Me personally I never use epub (I use software from my laptop, not from a mobile device). But I don't think it is really important. To generate a zip of html files must be really quick, so probably the issue is only pdf.

In fact, I never needed pdfs for the most recent version. I don't think it should be generated on every minor software update!

I would appreciate it much more if we had files for different versions. As of now, ReadTheDocs doesn't allow uploading them (or it is too complicated). I recently submitted a feature request connected to this issue.

I would also add that since RTD do all processing themselves, then probably it's their decision to regenerate everything, and RTD generation time should probably not be important for external projects.

@hugovk
Copy link
Member

hugovk commented Apr 28, 2023

Build times:

  • epub 34s
  • htmlzip 16s
  • pdf 25s

@radarhere
Copy link
Member

#7164 has now switched to only PDFs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants