SciML / DiffEqDocs.jl

Documentation for the DiffEq differential equations and scientific machine learning (SciML) ecosystem
https://docs.sciml.ai/DiffEqDocs/stable/
Other
278 stars 244 forks source link

Documentation in PDF format #508

Open coolshreysh1000 opened 3 years ago

coolshreysh1000 commented 3 years ago

I am able to access the online documentation and help at https://diffeq.sciml.ai/stable/

But I want a PDF version of above website for self - study and future reference. I am new to Julia and previously was using R. In R, the vignette of package is available as PDF

But in Julia I was able to find PDF documentation only for base julia at https://raw.githubusercontent.com/JuliaLang/docs.julialang.org/assets/julia-1.6.3.pdf

I tried different alternatives to convert website to PDF:

  1. Adobe Acrobat = Does not render latex in symbols
  2. wkhtml2pdf via python = Does not render latex in symbols
  3. selenium in python to automate chrome print to pdf = Renders pdf as image, text cannot be selected

I also downloaded entire zip archive of package from github. Then in make.jl file (inside docs folder) I changed format = Documenter.Latex(). This method is building all .md files but is unable to generate Latex file in my computer. It shows the error:

Error: LaTeXWriter: latexmk command not found

I searched (exact search) above error in Google, it shows only 1 result - the internal code on Github website I checked in R using TinyTex package and tlmgr_install("latexmk") command it shows already installed

Please help me by providing link / access to PDF documentation or julia / weave code to generate PDF documentation in my computer

ChrisRackauckas commented 3 years ago

Documenter.jl's github does this as well, so there's ways to do it. If someone figures it out we'll accept it.

youainti commented 2 years ago

So it looks like this is an issue with the requirements to compile to latex/pdf.

From your post, I'm guessing the requirements to generate PDFs is not registered with your path.

I checked in R using TinyTex package and tlmgr_install("latexmk") command it shows already installed

My guess is that R has installed latexmk within it's own package management system and executable path. Thus Julia has no access to the program.

@coolshreysh1000 I've got a couple of questions to help diagnose the issue:

Just to satisfy my curiosity, what is the specific pain point of using HTML that you feel PDFs would fix? I'm just curious as I personally prefer HTML for documentation and would love to get an insight into another perspective.

coolshreysh1000 commented 2 years ago
  1. I am running Windows 10. Specifically:
julia> versioninfo()
Julia Version 1.6.3
Commit ae8452a9e0 (2021-09-23 17:34 UTC)
Platform Info:
  OS: Windows (x86_64-w64-mingw32)
  CPU: Intel(R) Core(TM) i5-8250U CPU @ 1.60GHz
  WORD_SIZE: 64
  LIBM: libopenlibm
  LLVM: libLLVM-11.0.1 (ORCJIT, skylake)
  1. When I run latexmk I get:
PS C:\WINDOWS\system32> latexmk
Rc files read:
  NONE
Latexmk: This is Latexmk, John Collins, 20 November 2021, version: 4.76.
  1. When I run pdflatex I get:
PS C:\WINDOWS\system32> pdflatex
This is pdfTeX, Version 3.141592653-2.6-1.40.23 (TeX Live 2021/W32TeX) (preloaded format=pdflatex)
 restricted \write18 enabled.
**

I don't have any pain point of HTML. But I have multiple pleasure points for PDF:

  1. I can easily print & bind PDF to create print manual - It is less stressful to read books than screen.
  2. It is easier to share single PDF file than entire file folder of HTML across devices.
  3. It is easier to reference to different parts of manual using PDF (i.e. scrolling pages) than clicking on different hyperlinks.

For e.g. I have studied vignette of R package PerformanceAnalytics to study different measures of investment performance. I wish to do same with Differential Equations in julia.

In my laptop I tried very much to get julia to do PDF manual, but there are some latex issues that I was unable to resolve. So I thought that working on other computer can maybe solve the problem.