[PYTHON DOC-SIG] gendoc, etc.
Robin Friedrich
friedric@rose.rsoc.rockwell.com
Thu, 23 Jan 1997 14:41:33 -0600
Well I guess I'm one of the few who use gendoc without problems :-\
Some pointers:
I use gendoc as follows:
gendoc -i -d html -f HTMLg -h HTMLgen HTMLgen.py HTMLcolors.py HTMLutil.py
Notice I use the -i option. This tells gendoc to import the modules in
order to get the doc strings. If you don't do this, I think the default
is the parse option (which requires Fred Drake's Python parser module
to be built at your site). Importing is far faster and less problematic
so I recommend use of the -i option.
The HTMLg formatter (which makes calls to HTMLgen, so it'll have to be in
your pythonpath) seems to work fine. If you have several modules and would
like to have HTML generated with frames for quick navigation, be sure to
set the environment variable FRAME to something non null.
As far as your render_deflist problem I have it too when using the plain
HTML formatter so I suspect there is something wrong with it.
gendoc -f HTML gendoc_test.py will have several problems. For one, and this
is a trick, you can't run gendoc while your current directory is the gendoc
directory itself. So to run the above test I moved the gendoc_test.py file
to another directory and did the following based on the above recommendations:
gendoc -i -f HTMLg gendoc_test.py and it worked.
You might want to compare your gendoc directory list with mine below
to see if there are any missing files.
Good luck!
Robin
drwxr-xr-x 3 friedric admin 1024 Jan 13 13:50 ./
drwxr-xr-x 46 friedric admin 6144 Jan 13 13:50 ../
-r--r--r-- 1 friedric admin 950 Jul 12 1996 ABBLICENSE.DOC
-r--r--r-- 1 friedric admin 832 Jul 12 1996 ANNOUNCE.docco
-r--r--r-- 1 friedric admin 7890 Jul 12 1996 ASTWalker.py
-r--r--r-- 1 friedric admin 5772 Jul 12 1996 HTMLindex.py
-rw-r--r-- 1 friedric admin 4589 Sep 17 16:28 HTMLindex.pyc
-r--r--r-- 1 friedric admin 950 Jul 12 1996 LICENSE.DOC
-r--r--r-- 1 friedric admin 2647 Sep 6 04:57 Makefile
-r--r--r-- 1 friedric admin 16805 Sep 6 16:41 ManualPage.py
-rw-r--r-- 1 friedric admin 16114 Sep 17 16:28 ManualPage.pyc
-r--r--r-- 1 friedric admin 12561 Sep 6 04:58 ParseCollect.py
-r--r--r-- 1 friedric admin 4563 Sep 6 05:28 README
-r--r--r-- 1 friedric admin 1643 Jul 12 1996 README.docco
-r--r--r-- 1 friedric admin 9229 Aug 26 15:31 StructuredText.py
-rw-r--r-- 1 friedric admin 10201 Sep 17 16:28 StructuredText.pyc
-r--r--r-- 1 friedric admin 497 Jul 12 1996 TODO
-r--r--r-- 1 friedric admin 61 Jul 12 1996 __init__.py
-rw-r--r-- 1 friedric admin 201 Sep 17 16:28 __init__.pyc
-r--r--r-- 1 friedric admin 7698 Jul 12 1996 ast.py
-r--r--r-- 1 friedric admin 6835 Jul 12 1996 ast_doc.py
-r--r--r-- 1 friedric admin 20188 Sep 4 09:35 doc_collect.py
-rw-r--r-- 1 friedric admin 24575 Sep 17 16:28 doc_collect.pyc
-r--r--r-- 1 friedric admin 3231 Sep 18 07:50 docregex.py
-rw-r--r-- 1 friedric admin 1497 Oct 2 16:19 docregex.pyc
-r--r--r-- 1 friedric admin 8573 Sep 6 14:14 docutil.py
-rw-r--r-- 1 friedric admin 8488 Sep 17 16:28 docutil.pyc
drwxr-xr-x 2 friedric admin 512 Jan 13 13:50 formatters/
-r-xr-xr-x 1 friedric admin 82 Sep 3 14:44 gendoc*
-r--r--r-- 1 friedric admin 11349 Sep 6 05:06 gendoc.py
-rw-r--r-- 1 friedric admin 10739 Sep 17 16:28 gendoc.pyc
-r--r--r-- 1 friedric admin 2847 Sep 6 14:19 gendoc_test.py
-rw-r--r-- 1 friedric admin 9347 Sep 11 11:08 index.htp
-r--r--r-- 1 friedric admin 165 Jul 12 1996 symbol.py
-r--r--r-- 1 friedric admin 1050 Jul 12 1996 symbol_v1_3.py
-r--r--r-- 1 friedric admin 1062 Jul 12 1996 symbol_v1_4.py
-r--r--r-- 1 friedric admin 162 Jul 12 1996 token.py
-r--r--r-- 1 friedric admin 849 Jul 12 1996 token_v1_3.py
-r--r--r-- 1 friedric admin 864 Jul 12 1996 token_v1_4.py
./formatters:
total 166
drwxr-xr-x 2 friedric admin 512 Jan 13 13:50 ./
drwxr-xr-x 3 friedric admin 1024 Jan 13 13:50 ../
-r--r--r-- 1 friedric admin 3785 Sep 6 05:09 ASCIIFormatter.py
-rw-r--r-- 1 friedric admin 4204 Sep 17 16:28 ASCIIFormatter.pyc
-r--r--r-- 1 friedric admin 5000 Sep 6 05:12 Formatters.py
-rw-r--r-- 1 friedric admin 4183 Sep 17 16:28 Formatters.pyc
-r--r--r-- 1 friedric admin 914 Jul 9 1996 HTML.rc
-r--r--r-- 1 friedric admin 4373 Jul 8 1996 HTMLFormatter.py
-rw-r--r-- 1 friedric admin 6231 Sep 17 16:28 HTMLFormatter.pyc
-r--r--r-- 1 friedric admin 6999 Sep 17 16:48 HTMLgenFormatter.py
-rw-r--r-- 1 friedric admin 8971 Sep 17 17:02 HTMLgenFormatter.pyc
-r--r--r-- 1 friedric admin 7164 Sep 6 05:10 MIFFormatter.py
-rw-r--r-- 1 friedric admin 8137 Sep 17 16:28 MIFFormatter.pyc
-r--r--r-- 1 friedric admin 6701 Sep 6 05:11 MMLFormatter.py
-rw-r--r-- 1 friedric admin 7311 Sep 17 16:28 MMLFormatter.pyc
-r--r--r-- 1 friedric admin 144 Jul 8 1996 __init__.py
-rw-r--r-- 1 friedric admin 267 Sep 17 16:28 __init__.pyc
-r--r--r-- 1 friedric admin 362 Jun 24 1996 tags.mml
_______________
DOC-SIG - SIG for the Python Documentation Project
send messages to: doc-sig@python.org
administrivia to: doc-sig-request@python.org
_______________