epydoc - can I provide multiple dirs to parse

[Medi]

Can I present multiple directories to epydoc to process. For example

epydoc -option -option -option dir_1 dir_2 dir_3

where dir_i is a directory containing some python src codes ?

I am currently running it on two directories with about 10M + 20 Meg
which takes a very long time (more than 40 minutes) and strace(1) is
showing mmap(2) ops back to back....might not be related but the
process gets wedged somewhere

Thanks
Medi

 

[Jonathan Gardner]

Can I present multiple directories to epydoc to process. For example

epydoc -option -option -option dir_1 dir_2 dir_3

I know nothing of epydoc.

However, it looks like it should be something like:

epydoc -option dir_1 -option dir_2 -option dir_3

....if anything would work at all.

You may want to contact the epydoc mailing list for better guidance,
though.

 

[Jean-Michel Pichavant]

Can I present multiple directories to epydoc to process. For example

epydoc -option -option -option dir_1 dir_2 dir_3

where dir_i is a directory containing some python src codes ?

I am currently running it on two directories with about 10M + 20 Meg
which takes a very long time (more than 40 minutes) and strace(1) is
showing mmap(2) ops back to back....might not be related but the
process gets wedged somewhere

Thanks
Medi

Here is an ugly python script we are using to build the doc.

#!/usr/bin/python
# coding: utf-8

if __name__ == '__main__':
import sys
try :
import epydoc
except ImportError:
print "Error while importing epydoc"
print "Make sure it is installed"
from epydoc.cli import cli
modules = ['dir_1','dir_2','dir_3']
sys.argv = ["epydoc.py", "--html", "--no-frame", "--parse-only",
"--exclude=.*scripts.bug.*",
"--graph=all",
#"--no-sourcecode",
"--inheritance=grouped",
"-v",
"--output",
"/home/labsys/public_html"
] + sys.argv[1:]
sys.argv += modules
cli()

 

[Medi]

Can I present multiple directories toepydocto process. For example

epydoc-option -option -option dir_1 dir_2 dir_3

where dir_i is a directory containing some python src codes ?

I am currently running it on two directories with about 10M + 20 Meg
which takes a very long time (more than 40 minutes) and strace(1) is
showing mmap(2) ops back to back....might not be related but the
process gets wedged somewhere

Thanks
Medi

Here is an ugly python script we are using to build the doc.

#!/usr/bin/python
# coding: utf-8

if __name__ == '__main__':
        import sys
        try :
                importepydoc
        except ImportError:
                print "Error while importingepydoc"
                print "Make sure it is installed"
        fromepydoc.cli import cli
        modules = ['dir_1','dir_2','dir_3']
        sys.argv = ["epydoc.py", "--html", "--no-frame", "--parse-only",
                                        "--exclude=.*scripts.bug.*",
                                        "--graph=all",
                                        #"--no-sourcecode",
                                        "--inheritance=grouped",
                                        "-v",
                                        "--output",
"/home/labsys/public_html"
                                        ] + sys.argv[1:]
        sys.argv += modules
        cli()

Looks like multiple dir should work...
Also, what does the author mean by --inheritance=STYLE where style =
{ grouped, listed, included } . The help text does not explain this
well.

 

[Jean-Michel Pichavant]

Thank you

It looks like it is possible to feed multiple dirs,

Also, can you explain the --inheritance=STYLE for me. What does the
author mean by values like "grouped", "listed", "included"
I could not find any good document explaining these...

Thanks
Medi

Sorry, I don't remember exactly. It is related somehow to how epydoc
will manage inheritance, for example if C inherits from A, in C
documention, epydoc can include the documentation of A methods like if
they were defined in C, or it can just list the method names, or
whatever ... just try the options on one file and you'll get a better
view on this option.

JM