[Doc-SIG] Python docs in reST

Fred L. Drake, Jr. fdrake at acm.org
Fri May 27 20:49:02 CEST 2005


On Friday 27 May 2005 10:32, Felix Wiemann wrote:
 > Then you need a new "subdocument" directive.  The "include" directive
 > can't do that.

If ..include doesn't do it, we'd certainly need it.  I'd not want an included 
document to be able to change the current tree context, only add children to 
the current node.  ..subdocument would be used to include content, 
and ..include would be used to load custom definitions.

 > If you want to store Docutils' node tree, XML is the most natural
 > choice.  That wouldn't change the openness of the system, and neither is
 > anybody expected to fiddle with XML files.  It's just a serialization of
 > an intermediate processing stage.

Yes; whether XML or something else makes sense depends on how "open" that 
intermediate form needs to be.  An alternative might be pickles, which are 
substantially less open, but can probably be loaded more quickly.

 > From my profiling results, much time is spent in the statemachine and in
 > the regular expressions.  Dunno how much this can be optimized, though.

Good to know.  I've not reviewed this code, but it seems like a good time to 
check it out.  Not sure how much time I'll have; I've only managed time for 
these discussions because I'm on vacation this week.  Needless to say, that's 
rapidly coming to a close.  (Though I'll still keep up as best I can.)


  -Fred

-- 
Fred L. Drake, Jr.   <fdrake at acm.org>


More information about the Doc-SIG mailing list