[Dev] document generation changes - my mad scheme to rule the world
Mike Taylor
bear at code-bear.com
Fri Sep 16 10:02:43 PDT 2005
Hi all,
I figured I would post some changes I'm planning on doing to the
documentation generation landscape so I can get any feedback if needed.
- Schema Model Docs -
Currently the Schema Model documentation is generated by the
genmodeldocs.py program that lives in chandler/distrib/docgen/ -- after
looking at it I realized that it was using private functions to setup
the repository and parcels so I refactored it to use the
application/Utility.py routines.
After doing that refactoring I realized that
chandler/distrib/docgen/Util.py would no longer be needed. That
prompted me to move genmodeldocs.py into my new tools/gen_docs.py
program. After doing that, it left only schema.css in the
chandler/distrib/docgen/ dir so I moved that to chandler/tools/
- "source" Chandler Document Index -
In the chandler/distrib/ tree is a directory named docs/ -- it holds
the master copy of the files used to build the Chandler documentation
part of the website. These five files have been in the distrib tree
for a while now even though they are not distributed with Chandler.
Now that I'm cleaning out some other files, I'm feeling compelled to
move them out also. I will be moving them to the tools/docs/ directory
and updating the appropriate code that references them.
So, basically I want to clear out chandler/distrib/docgen - moving
genmodeldocs code into gen_docs and relocating the distrib/docgen/docs/
directory to the tools/ directory.
Unless I hear any major negative feedback I'll be doing this tomorrow.
thanks,
---
Bear
Build and Release Engineer
Open Source Applications Foundation (OSAF)
bear at osafoundation.org
http://www.osafoundation.org
bear at code-bear.com
http://code-bear.com
PGP Fingerprint = 9996 719F 973D B11B E111 D770 9331 E822 40B3 CD29
-------------- next part --------------
A non-text attachment was scrubbed...
Name: PGP.sig
Type: application/pgp-signature
Size: 186 bytes
Desc: This is a digitally signed message part
Url : http://lists.osafoundation.org/pipermail/dev/attachments/20050916/433fbc17/PGP.pgp
More information about the Dev
mailing list