incubator-allura-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Cory Johns <cjo...@slashdotmedia.com>
Subject Allura docs reorganization
Date Tue, 23 Jul 2013 18:36:54 GMT
In adding docs for the new importer code, I'm considering reorganizing the
docs structure in Allura to make it easier to document the multiple
packages.

I'm going to move most of the documentation that's currently under
Allura/docs/ up to a top-level docs/ folder, which will be the docs index
and place for any narrative and platform-wide docs.  Then, each package can
have a docs/ sub-directory for documentation specific to that package,
primarily API docs for the classes in that package (which are generated
from the doc strings).

This will require building docs across multiple folders and doing some
post-build path restructuring of the generated artifacts, but would keep
the docs for a package within that package directory.

Anyone have any comments, concerns, or objections on this restructure?


- Cory

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message