Re: [Docutils-develop] split output (was Re: sandbox/tibs/pysource/notes thoughts.txt)

[David G. <go...@us...>]

[Richard]
>> Haven't looked at javadoc for a while - what's this mean?

[Tibs]
> As David guessed, it means the sort of thing that javadoc does -
> specifically, it produces a directory structure, containing (in
> general) an HTML file for each class, a directory for each package,
> index and contents pages, maybe a summary page for each package, and
> (I think) other bumf as well.

One thing to take out of this, is to compare how different tools
generate their collections of files.  Epydoc makes one directory with
a slew of files, some with *very* long names, like
"docutils.parsers.rst.states.EnumeratedList.html".  I'd much prefer to
use the filesystem to organize files hierarchically, as in
"docutils/parsers/rst/states/EnumeratedList.html".  This was one of
the reasons I got interested in auto-documentation in the first place:
pythondoc did the long name thing, and MacOS classic couldn't handle
it with its 38-char filename limit.

So here's a requirement: when splitting files, each split level should
generate a new directory rather than another segment of a compound file
name.

-- 
David Goodger  <go...@us...>  Open-source projects:
  - Python Docutils: http://docutils.sourceforge.net/
    (includes reStructuredText: http://docutils.sf.net/rst.html)
  - The Go Tools Project: http://gotools.sourceforge.net/