David Goodger | 4 Jul 2003 03:35
Favicon

Re: Re: [Docutils-checkins] docutils/spec notes.txt,1.160,1.161

[David Goodger, in a CVS diff]
 >> * The "docutils.conf" included with Docutils should become complete,
 >>+  with examples of every setting (many/most commented out).  It's
 >>+  currently sparse, requiring doc lookups.

[Engelbert Gruber]
 > i donot think this is feasable or useable.

Perhaps; we'll see.  I'll try it out myself anyhow.

In any case, the default config file should include a reference to the
config file docs.

 >>+* Rework docs/tools.txt for the new configuration sections.  Merge
 >>+  doc/latex.txt info into tools.txt.
 >
 > same as above (but maybe it is just me that does not like to stumble
 > through tons of pages) make it modules.

I disagree here.  Please note, I'm not saying all of docs/latex.txt
should be merged, just the config/settings info.  All settings should
be documented in one place.  docs/tools.txt may be getting too big, in
which case I wouldn't be averse to splitting the config file parts out
into a docs/config.txt file.  The LaTeX stylesheet may require
separate documentation, but not the config file settings.  And at
least a brief summary of rst2latex.py should be part of
docs/tools.txt.

--

-- 
David Goodger    http://starship.python.net/~goodger
For hire: http://starship.python.net/~goodger/cv
Docutils: http://docutils.sourceforge.net/
(includes reStructuredText: http://docutils.sf.net/rst.html)

-------------------------------------------------------
This SF.Net email sponsored by: Free pre-built ASP.NET sites including
Data Reports, E-commerce, Portals, and Forums are available now.
Download today and enter to win an XBOX or Visual Studio .NET.
http://aspnet.click-url.com/go/psa00100006ave/direct;at.asp_061203_01/01

Gmane