[Tutor] automatically generate python/pylons documentation

[Arun Tomar]

hi!

On Sat, Oct 18, 2008 at 10:42 PM, Alan Gauld <alan.gauld at btinternet.com> wrote:
> "Arun Tomar" <tomar.arun at gmail.com> wrote
>>
>> if i give the command for epydoc to generate the documentation it
>> gives the below mentioned errors:
>>
>> epydoc helloworld/
>>  Error: Directory 'helloworld/' is not a package
>>  Error: Nothing left to document!
>
> What happens if you don;t pass the trainiling slash:
>
> epydoc helloworld

if i do not give a trailing slash, the output is like this
epydoc helloworld
+-----------------------------------------------------------------------------------------------------------------------
| In helloworld:
| No documentation available!
|     Error: Import failed:
|            ImportError: No module named helloworld
|
  Error: Nothing left to document!

>
> Alrternatively just make it a package by creating an init.py file as
> suggested by Marc
>
> Alan G

creating a __init__.py file does the trick but not completely.
 epydoc helloworld
+-----------------------------------------------------------------------------------------------------------------------
| In /tmp/helloworld/setup.py:
| Import failed (but source code parsing was successful).
|     Error: SystemExit: usage: (imported) [global_opts] cmd1
[cmd1_opts] [cmd2 [cmd2_opts] ...]
|               or: (imported) --help [cmd1 cmd2 ...]
|               or: (imported) --help-commands
|               or: (imported) cmd --help
|
|            error: no commands supplied (line 30)
|
+-----------------------------------------------------------------------------------------------------------------------
| In /tmp/helloworld/helloworld/websetup.py:
| Import failed (but source code parsing was successful).
|     Error: ImportError: No module named config.environment (line 7)
|
+-----------------------------------------------------------------------------------------------------------------------
| In /tmp/helloworld/helloworld/config/middleware.py:
| Import failed (but source code parsing was successful).
|     Error: ImportError: No module named config.environment (line 13)
|
+-----------------------------------------------------------------------------------------------------------------------
| In /tmp/helloworld/helloworld/config/environment.py:
| Import failed (but source code parsing was successful).
|     Error: ImportError: No module named lib.app_globals (line 6)
|
+-----------------------------------------------------------------------------------------------------------------------
| In /tmp/helloworld/helloworld/controllers/template.py:
| Import failed (but source code parsing was successful).
|     Error: ImportError: No module named lib.base (line 1)
|
+-----------------------------------------------------------------------------------------------------------------------
| In /tmp/helloworld/helloworld/controllers/error.py:
| Import failed (but source code parsing was successful).
|     Error: ImportError: No module named lib.base (line 6)
|
+-----------------------------------------------------------------------------------------------------------------------
| In /tmp/helloworld/helloworld/tests/__init__.py:
| Import failed (but source code parsing was successful).
|     Error: ImportError: No module named config.middleware (line 33)
|
+-----------------------------------------------------------------------------------------------------------------------
| In /tmp/helloworld/helloworld/tests/test_models.py:
| Import failed (but source code parsing was successful).
|     Error: ImportError: No module named config.middleware (line 33)
|
+-----------------------------------------------------------------------------------------------------------------------
| In /tmp/helloworld/helloworld/tests/functional/__init__.py:
| Import failed (but source code parsing was successful).
|     Error: ImportError: No module named config.middleware (line 33)
|
+-----------------------------------------------------------------------------------------------------------------------
| In /tmp/helloworld/helloworld/lib/base.py:
| Import failed (but source code parsing was successful).
|     Error: ImportError: No module named lib.helpers (line 13)
|
Warning: No information available for
helloworld.helloworld.lib.base.BaseController's base
         pylons.controllers.WSGIController
Warning: 1 markup error was found while processing docstrings.  Use
the verbose switch (-v) to display markup errors.

this creates a directory with the documentation which is working but
as you can see there are some import errors.

regds,
arun