#6495: Build the reference manual incrementally
----------------------------------------------------------------------------------------------------------------+
Reporter: mpatel
| Owner: tba
Type: enhancement
| Status: needs_review
Priority: major
| Milestone: sage-pending
Component: documentation
| Resolution:
Keywords: days38
| Work issues:
Report Upstream: N/A
| Reviewers: Volker Braun
Authors: Mitesh Patel, John Palmieri, Florent Hivert
| Merged in:
Dependencies: #13126, #11078, #11874, #12229, #11503, #12327, #11080,
#9774, #8473, #11913, #12299, #13121 | Stopgaps:
----------------------------------------------------------------------------------------------------------------+
Comment (by jhpalmieri):
In addition to the warning mentioned in [comment:105], I have a question
about `.buildinfo` files. It seems that on the first pass through the
reference manual, these files contain lines like
{{{
config: 6a23e6beb735e39dc46994bfb813cf55
tags: fbb0d17656682115ca4d033fb2f83ba1
}}}
On the second pass, these files get overwritten, and the new files have
{{{
config:
tags:
}}}
Then running `sage --docbuild reference all` produces warnings like
{{{
WARNING: unsupported build info format in
'.../devel/sage/doc/output/html/en/reference/libs/.buildinfo', building
all
}}}
and then everything is rebuilt again. I propose this change, which seems
to fix this issue:
{{{
#!diff
diff --git a/doc/common/builder.py b/doc/common/builder.py
--- a/doc/common/builder.py
+++ b/doc/common/builder.py
@@ -300,7 +300,7 @@ class AllBuilder(object):
logger.warning("Building reference manual, second pass.\n")
ALLSPHINXOPTS = ALLSPHINXOPTS.replace(
'multidoc_first_pass=1', 'multidoc_first_pass=0')
- ALLSPHINXOPTS = ALLSPHINXOPTS.replace('-Q', '-q') + ' -a '
+ ALLSPHINXOPTS = ALLSPHINXOPTS.replace('-Q', '-q') + ' '
for document in refs:
getattr(get_builder(document), name)(*args, **kwds)
}}}
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6495#comment:110>
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.
