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

Documentation in PDF format #2402

Closed
tebeka opened this issue Dec 27, 2020 · 9 comments
Closed

Documentation in PDF format #2402

tebeka opened this issue Dec 27, 2020 · 9 comments

Comments

@tebeka
Copy link

tebeka commented Dec 27, 2020

It'll be great to have the documentation in PDF format as well. I'm teaching in a place when they don't always have external internet.

@tebeka
Copy link
Author

tebeka commented Dec 27, 2020

To build the PDF docs I had to add sphinx.ext.imgconverter to the extensions in doc/conf.py

@mwaskom
Copy link
Owner

mwaskom commented Dec 27, 2020

I don't expect that pdf docs would render very well ... if you don't have external internet my suggestion would be to build the html site locally and view it in your browser. Instructions for doing so are here: https://github.com/mwaskom/seaborn/tree/master/doc#building-the-seaborn-docs

I guess you'll need the example datasets cached if you want to build when there's no internet available.

@mwaskom
Copy link
Owner

mwaskom commented Dec 27, 2020

Actually maybe even easier than building locally would just be to clone the docs website: https://github.com/seaborn/seaborn.github.io/

@mwaskom
Copy link
Owner

mwaskom commented Dec 27, 2020

I wasn't able to get a PDF build working with a little bit of effort, and anyway I suspect the file would be rather large, so I would be disinclined from sharing it publicly via the main website, which is a github repo and subject to space constraints.

But I added a note to the docs readme mentioning that the website repo is a good source for offline docs, and I additionally tagged each release back to v0.8.0, allowing github to provide a simple zipfile download of the corresponding docs.

If you think a PDF file would be a better approach for your students, you're certainly welcome to build one and share it with them.

@mwaskom mwaskom closed this as completed Dec 27, 2020
@tebeka
Copy link
Author

tebeka commented Dec 28, 2020

Thanks! I'm attaching the generated PDF for ... not really sure :) I don't think it's bad.

seaborn.pdf

@mwaskom
Copy link
Owner

mwaskom commented Dec 28, 2020

It looks like this is missing all the content for the user guide/tutorial. Is that deliberate?

@mwaskom
Copy link
Owner

mwaskom commented Dec 28, 2020

It also doesn't have code/images in the API section, at least for the functions using the newer system.

@tebeka
Copy link
Author

tebeka commented Dec 28, 2020

It looks like this is missing all the content for the user guide/tutorial. Is that deliberate?

Nope. I ran make latexpdf and that's what came out.

@mwaskom
Copy link
Owner

mwaskom commented Dec 28, 2020

Looks like you missed the step where you build the notebooks: https://github.com/mwaskom/seaborn/tree/master/doc#building-the-seaborn-docs

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

2 participants