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

Update ReadTheDocs pdf or remove it and provide an updated PDF doc #22704

Closed
scls19fr opened this issue Jul 7, 2017 · 16 comments
Closed

Update ReadTheDocs pdf or remove it and provide an updated PDF doc #22704

scls19fr opened this issue Jul 7, 2017 · 16 comments
Labels
domain:docs This change adds or pertains to documentation

Comments

@scls19fr
Copy link
Contributor

scls19fr commented Jul 7, 2017

Hello,

Following #20418 (comment)

A Google search with "julia 0.6 pdf doc"

https://www.google.fr/search?q=julia%200.6%20pdf%20doc

shows

Julia Language Documentation - Read the Docs
https://media.readthedocs.org/pdf/julia/latest/julia.pdf

[PDF]Julia Language Documentation - Read the Docs
https://media.readthedocs.org/pdf/julia/stable/julia.pdf

but these docs are not updated.

ReadTheDocs pdf should be updated or removed

Pinging @tkelman @nalimilan

Kind regards

@scls19fr
Copy link
Contributor Author

scls19fr commented Jul 7, 2017

A PDF version of language documentation would also a nice feature to have (again).
https://docs.julialang.org/ doesn't seems to provide such a PDF version

@nalimilan
Copy link
Member

I think we should just remove the Read the Docs project, just like we recently did for StatsBase. It's easy to do from the project page, but if an admin gives the me authorizations I can do it.

@tkelman
Copy link
Contributor

tkelman commented Jul 7, 2017

All the old links there are for old versions, but what would shutting it off do to all those links? Can we put in a redirect somehow?

@scls19fr
Copy link
Contributor Author

scls19fr commented Jul 7, 2017

Some other Julia users are also looking for PDF version of doc
https://discourse.julialang.org/t/pdf-version-of-docs-for-v0-6/4559/13

@nalimilan
Copy link
Member

After closing a project, all links give an empty page: http://dataframesjl.readthedocs.io/. It seems they provide a redirect feature: https://docs.readthedocs.io/en/latest/user-defined-redirects.html

@cossio
Copy link
Contributor

cossio commented Aug 6, 2017

I believe a PDF version of the docs would be very nice. For example, this is a nice format if you want to read on a tablet, or if you want to write annotations to it. Also, it's a single file which makes it very portable.

@cossio
Copy link
Contributor

cossio commented Aug 6, 2017

Could we rename this issue to "PDF version of the docs" or something like that? Itsn't just about updating / removing the outdated readthedocs version. It's also about maintaining a PDF version of the latest docs, don't you agree @scls19fr ?

@iblislin
Copy link
Member

iblislin commented Aug 6, 2017

Actually the PDF file can be generated via make -C doc pdf simply, so... if we want PDF file be auto-deployed, we will need to patch deploydocs of Documenter.


TheJuliaLanguage.pdf
Edit: ^^^ seems some fonts is missing from my latex env, so it looks weird.

@cossio
Copy link
Contributor

cossio commented Aug 6, 2017

@iblis17 Thanks, where can I run this command to compile a PDF myself? I see the PDF generated has some issues.

@iblislin
Copy link
Member

iblislin commented Aug 6, 2017

cd /path/to/your/julia/repo && make -C doc pdf
and it's at doc/_build/html/en/TheJuliaLanguage.pdf

@scls19fr scls19fr changed the title Update ReadTheDocs pdf or remove it Update ReadTheDocs pdf or remove it and provide an updated PDF doc Aug 6, 2017
@sarming
Copy link

sarming commented Aug 17, 2017

After installing the fonts I also had to add \usepackage{shellesc} to the preamble of TheJuliaLanguage.tex, see this TeX.SE answer.
Anyway, here is the pdf: TheJuliaLanguage.pdf

@cossio
Copy link
Contributor

cossio commented Aug 17, 2017

@sarming Nice, thanks.

@IngoMeyer441
Copy link

Here is the PDF documentation for the current stable version 0.6.2:
TheJuliaLanguage_v0.6.2.pdf

@kshyatt kshyatt added the domain:docs This change adds or pertains to documentation label May 28, 2018
@adamryczkowski
Copy link

Here is the PDF with the current master (marked as version 1.1.0)
TheJuliaLanguage 1.1.0.pdf

@adamryczkowski
Copy link

adamryczkowski commented Aug 19, 2018

Note, that the Roboto Mono font the docs are using right now lacks several Unicode math symbols. Further details on JuliaDocs/Documenter.jl#803

@mortenpi
Copy link
Contributor

An up-to-date PDF has been available for a while now, advertised on the main page of the docs, so this can be closed I think. cc @fredrikekre

The Unicode issue is tracked in #31048.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation
Projects
None yet
Development

No branches or pull requests