search

JunoLab / Weave.jl

Scientific reports/literate programming for Julia
http://weavejl.mpastell.com
MIT License
833 stars 96 forks source link

Describing how to compile documents #31

Open sje30 opened 9 years ago

sje30 commented 9 years ago

Hi,

would it be worth including some text in the examples noting how to re-generate the documents? For example, something like this in the end of examples/julia_latex.texw

<<eval=false>>=
using Weave
weave(Pkg.dir("Weave","examples","julia_latex.texw"), doctype="tex")
@

The .tex file will be found in the examples folder, from where you can
compile it to a PDF.

Also, with the auto-generated files, such as julia_latex.tex would it be worth adding a comment at the top of the file to note that the file should not be edited directly, but to point back to the .texw file? e.g. something like

%% This file has been automatically generated from julia_latex.texw

so that people don't mistakenly edit the .tex file later.

mpastell commented 8 years ago

There is now an improved getting started in the latest version of docs, I will keep the issue open to remind me to add the comment to tex files at some point.