#9252: documentation errors in tutorial
------------------------------+---------------------------------------------
Reporter: wjlaffin | Owner: wjlaffin
Type: defect | Status: needs_work
Priority: trivial | Milestone: sage-4.4.4
Component: documentation | Keywords:
Author: William Laffin | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
------------------------------+---------------------------------------------
Comment(by jhpalmieri):
Replying to [comment:4 wjlaffin]:
> When you(or really anyone) says "static version" do they mean the pdf's?
No, the html version. From the command line, execute "tutorial()", or
from the notebook click the "Help" button and then the button for "Fast
Static Versions of the Documentation". Then click on the word "Tutorial".
Or open the file
SAGE_ROOT/devel/sage/doc/output/html/en/tutorial/index.html in your web
browser.
> On that note, where is the code that adds the $$=latex hack to the
documentation? Maybe I can just patch that a little instead.
>
> What about the literal blocks that are meant for the interactive shell?
'sage:' always gets turned into a cell, so I needed to add some kind of
header in the literal block (a bad hack) to get it to print correctly in
the live-help.
Some of this is in sage/sage/misc/sagedoc.py (e.g.,
{{{process_dollars}}}). See also SAGE_ROOT/devel/sage/doc/common/conf.py.
It looks like the conversion from the html file to the "live" version of
the docs is in the notebook code: SAGE_ROOT/local/lib/python/site-
packages/sagenb-0.8-py2.6.egg/sagenb/notebook/docHTMLProcessor.py, it
looks like. Since you're dealing with differences between the static and
the live versions, you may need to look there.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9252#comment:5>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
