#6495: Build the reference manual incrementally
-----------------------------+----------------------------------------------
Reporter: mpatel | Owner: tba
Type: enhancement | Status: needs_work
Priority: major | Milestone:
Component: documentation | Keywords:
Work_issues: | Author: Mitesh Patel
Upstream: N/A | Reviewer:
Merged: |
-----------------------------+----------------------------------------------
Changes (by mpatel):
* priority: minor => major
* upstream: => N/A
* type: defect => enhancement
Comment:
The [attachment:trac_6495-reference_breakup.patch new patch] may make it
possible to build and update reference manual chapters semi-independently.
I think we can use the [http://sphinx.pocoo.org/ext/intersphinx.html
intersphinx extension] to fix the cross-chapter references. But we'll
need to build the manual twice, a la LaTeX.
To build just a chapter, try, e.g.,
{{{
sage -docbuild reference/algebras html -juiv3
}}}
Still to do:
* Make a combined index page and search page.
* Check that PDF generation works.
* Combine chapter PDF files into one large [optional] PDF file (with
[http://www2.warwick.ac.uk/fac/sci/statistics/staff/academic/firth/software/pdfjam
pdfjam's] pdfjoin)?
* Use a specific LaTeX doc title in each `conf.py`.
* Fix the "Arithmetic Subgroups" heading on the top-level page.
* Use a visual, 2D layout for the top-level page? Group by general area?
Add icons?
* Get a reply from [http://groups.google.com/group/sphinx-
dev/browse_thread/thread/c8e6f0683c65930a sphinx-dev] about making
relative paths work.
* Build docs in parallel (cf. #6255) with
[http://docs.python.org/library/multiprocessing.html multiprocessing]?
* Replace the "website" PDF link?
* User-friendliness improvements.
* Encourage more compact chapters? It seems that "Combinatorics" takes
the most time and memory.
* ...
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6495#comment:4>
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.
