Opened 5 years ago

Closed 5 years ago

#17068 closed defect (fixed)

Update SageTeX documentation in tutorial

Reported by: kcrisman Owned by:
Priority: critical Milestone: sage-6.4
Component: documentation Keywords:
Cc: ddrake Merged in:
Authors: Dan Drake Reviewers: Dima Pasechnik
Report Upstream: N/A Work issues:
Branch: e69695d (Commits) Commit: e69695d385cc65186972ffd2365a06f0f242d860
Dependencies: Stopgaps:

Description

I'm preparing a brief talk on using SageTeX, and discovering that the tutorial seems to be incorrect.

http://www.sagemath.org/doc/tutorial/sagetex.html

"The full documentation can be found in SAGE_ROOT/local/share/texmf/tex/generic/sagetex, where SAGE_ROOT is the directory where your Sage installation is located."

In fact, it refers to this for the doc a few times. It also refers to the incorrect name for the .sage file produced, which should be st_example.sagetex.sage

The installation guide seems to be correct...

http://www.sagemath.org/doc/installation/sagetex.html

says

"While not strictly part of installation, it bears mentioning here that the documentation for SageTeX is maintained in SAGE_ROOT/local/share/doc/sagetex/sagetex.pdf. There is also an example file in the same directory – see example.tex and example.pdf, the pre-built result of typesetting that file with LaTeX and Sage."

Change History (9)

comment:1 follow-up: Changed 5 years ago by ddrake

I fixed the documentation. Now I need to figure out how do the git & trac stuff to get it here...

comment:2 in reply to: ↑ 1 Changed 5 years ago by dimpase

Replying to ddrake:

I fixed the documentation. Now I need to figure out how do the git & trac stuff to get it here...

you might use this: https://github.com/sagemath/git-trac-command

if you're very short on time, then just put the patch here, as an attachment...

comment:3 Changed 5 years ago by ddrake

  • Branch set to u/ddrake/update_sagetex_documentation_in_tutorial

comment:4 Changed 5 years ago by ddrake

  • Commit set to e69695d385cc65186972ffd2365a06f0f242d860
  • Status changed from new to needs_review

Patch...er, git branch up. Please review.


New commits:

e69695dfix directories to reflect current documentation

comment:5 Changed 5 years ago by dimpase

  • Reviewers set to Dima Pasechnik
  • Status changed from needs_review to positive_review

Looks good to me!

comment:6 Changed 5 years ago by kcrisman

Awesome work, thanks guys! Now I can tell the students at AIMS to just use the documentation (well, in the next version of Sage...)

comment:7 Changed 5 years ago by vbraun

  • Status changed from positive_review to needs_work

Author name missing

comment:8 Changed 5 years ago by kcrisman

  • Authors set to Dan Drake
  • Status changed from needs_work to positive_review

comment:9 Changed 5 years ago by vbraun

  • Branch changed from u/ddrake/update_sagetex_documentation_in_tutorial to e69695d385cc65186972ffd2365a06f0f242d860
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.