[Python-Dev] Request for guidance on documentation

[Fred L. Drake, Jr.]

Moshe Zadka writes:
 > Neither of those reasons are enough not to put the HOWTOs in the CVS tree.
 > Editors can keep the version in the CVS current via the patch manager,
 > and release them as they need to. However, people who d/l Python will
 > automatically download the HOWTOs. Think of perldoc lol (lists of lists)
 > -- definitely "HOWTO" material, but in the Perl standard docs.

  I'm happy to have them under CVS; I think the big issue is *where*.
I'm not convinced they belong in the same portion of the tree as the
standard documentation.
  Here's a thought: we currently have

  dist/
      src/
          Doc/

  Instead, we could have:

  dist/
      docs/
          howto/
          standard/
      src/

  The howto/ tree could be the howto collection Andrew maintains, and
standard/ could be the XML version of the documentation once I've
converted everything (which just shouldn't been in src/ to begin
with).
  The documentation tools would become a separate component (which
I've been thinking about for a while now), used by both the standard
documentation and the howtos.
  Another option would be to simply create a new SourceForge project
for HOWTO documents.  That would be Andrew's baby, so would have to be
his preferred approach.


  -Fred

-- 
Fred L. Drake, Jr.  <fdrake at beopen.com>
BeOpen PythonLabs Team Member