#8464: add FAQ to standard documentation
-------------------------------+--------------------------------------------
Reporter: mvngu | Owner: mvngu
Type: enhancement | Status: needs_work
Priority: major | Milestone: sage-4.4
Component: documentation | Keywords: FAQ
Author: Minh Van Nguyen | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-------------------------------+--------------------------------------------
Comment(by jhpalmieri):
The documents build without error and they look good, in both html and
pdf. I have a few comments about the content:
- in faq-general.rst, at the end: do we need to include instructions for
building the documentation, since it is downloadable, included in any
binary distribution, and automatically built when building any source
distribution? Note that you can also build the docs using
{{{
make doc or make doc-html
make doc-pdf
}}}
I don't know if it's worth mentioning these alternatives. In the same
part, I would suggest changing the path to the documentation: replace
"sage-main" by "sage". Also in the same part, in the spirit of #21 and
standard GNU-style command line options, how about changing {{{sage
-docbuild ...}}} to {{{sage --docbuild ...}}}, and similarly for {{{sage
-help}}} and {{{sage -advanced}}}? (Same issue with "you need to invoke
Sage with the option ``-python``" in faq-usage.rst, and perhaps elsewhere
-- I haven't done a careful search.)
- for faq-usage.rst, the prerequisites: should we mention LaTeX as a
suggested package?
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8464#comment:9>
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.
