happydoc-discuss — Public discussion of HappyDoc-related topics.

Re: [HappyDoc-discuss] incantation for multiple packages

[Doug H. <do...@he...>]

Donnal,

Thanks for sending me the details of what did and didn't work.  It will make 
my testing/bug fixing easier when I can get time to do it.  I really 
appreciate the feedback, and I'm glad you finally got *something* to work.  
:-)

Doug

Re: [HappyDoc-discuss] incantation for multiple packages

[Donnal W. <don...@ya...>]

--- Donnal Walter <don...@ya...> wrote:
> --- Doug Hellmann <do...@he...> wrote:
> > For example, try:
> > 
> > C:\>C:\Python22\Scripts\happydocwin.py -d \Prism\Docs\api
> > \Prism\Lib
> > 
> > Please let me know if that works, since it will confirm my
> > suspicions about what is broken.
> 
> No, this still generated all of the module HTML pages inside the
> packages where the modules are located.

Actually, to take my trial and error findings yet one step further,
your original suggestion DOES work with a *dot* in front of the
path names:

C:\>C:\Python22\Scripts\happydocwin.py -d .\Prism\Docs\api
.\Prism\Lib

Thanks again. HappyDoc is terrific.





=====
Donnal Walter
Arkansas Children's Hospital

__________________________________________________
Do You Yahoo!?
Yahoo! Sports - live college hoops coverage
http://sports.yahoo.com/

Re: [HappyDoc-discuss] incantation for multiple packages

[Donnal W. <don...@ya...>]

--- Doug Hellmann <do...@he...> wrote:
> On Monday 18 March 2002 07:36, Donnal Walter wrote:
> > Using Python 2.2 on Windows 2000 Pro, I am working on an
> > application contained in three packages:
> 
> [...]
> 
> > How can I generate ALL of the documentation in \Docs\api (and
> > its corresponding subdirectories)? Thanks.
> 
> There are still some bugs with path handling on win32 systems.  I
> think I've worked out what the problems are, but I haven't had a
> chance to boot into windows to work on the fixes.  Try not using
> the "C:" on the front of your paths, since I know drive letters
> confuse the path code right now.
> 
> For example, try:
> 
> C:\>C:\Python22\Scripts\happydocwin.py -d \Prism\Docs\api
> \Prism\Lib
> 
> Please let me know if that works, since it will confirm my
> suspicions about what is broken.

No, this still generated all of the module HTML pages inside the
packages where the modules are located.

> If that does not work, this workaround might help until I fix the
> problem.  If you do not specify *any* path using the -d option,
> the output should be written to C:\Prism\Lib\docs.  You could
> then rename/move that directory to where you want it to be.

Okay, so I tried:
C:\>C:\Python22\Scripts\happydocwin.py  \Prism\Lib

Unfortunately this did exactly the same thing. All of the HTML
pages were written to the directories where the modules were. I
tried two or three other combinations that did not work either.
Then I stumbled onto this formula:

C:\>cd Prism\Lib
C:\Prism\Lib>C:\Python22\Scripts\happydocwin.py ..\Lib

This worked!! ALL the output was written to C:\Prism\Lib\doc, which
I moved and renamed as you suggested. Emboldened by this success,
however, I tried naming the destination again:

C:\>cd Prism\Lib
C:\Prism\Lib>C:\Python22\Scripts\happydocwin.py
 -d ..\Docs\api ..\Lib

This worked too, writing everything to C:\Prism\Docs\api. Then I
tried simplifying it one more step:

C:\>cd Prism
C:\Prism>C:\Python22\Scripts\happydocwin.py -d .\Docs\api .\Lib

This incantation works too. The output is gorgeous (and extremely
helpful). Thank you for your help.



=====
Donnal Walter
Arkansas Children's Hospital

__________________________________________________
Do You Yahoo!?
Yahoo! Sports - live college hoops coverage
http://sports.yahoo.com/

Re: [HappyDoc-discuss] incantation for multiple packages

[Doug H. <do...@he...>]

On Monday 18 March 2002 07:36, Donnal Walter wrote:
> Using Python 2.2 on Windows 2000 Pro, I am working on an
> application contained in three packages:

[...]

> How can I generate ALL of the documentation in \Docs\api (and its
> corresponding subdirectories)? Thanks.

There are still some bugs with path handling on win32 systems.  I think I've 
worked out what the problems are, but I haven't had a chance to boot into 
windows to work on the fixes.  Try not using the "C:" on the front of your 
paths, since I know drive letters confuse the path code right now.

For example, try:

C:\>C:\Python22\Scripts\happydocwin.py -d \Prism\Docs\api \Prism\Lib

Please let me know if that works, since it will confirm my suspicions about 
what is broken.

If that does not work, this workaround might help until I fix the problem.  
If you do not specify *any* path using the -d option, the output should be 
written to C:\Prism\Lib\docs.  You could then rename/move that directory to 
where you want it to be.

Thanks,
Doug

[HappyDoc-discuss] incantation for multiple packages

[Donnal W. <don...@ya...>]

Using Python 2.2 on Windows 2000 Pro, I am working on an
application contained in three packages:

C:\Prism\Lib\core
C:\Prism\Lib\model
C:\Prism\Lib\control

There are 4 - 20 modules within each package and I would like to
generate HTML documentation for the entire application at one time
to be placed in the directory C:\Prism\Docs\api.

When I used the following command from the C:\> prompt

C:\>C:\Python22\Scripts\happydocwin.py -d C:\Prism\Docs\api
C:\Prism\Lib

there was indeed an index.html file in C:\Prism\Docs\api that
pointed to the rest of the files, but these were generated in
C:\Prism\Lib and its subdirectories.

How can I generate ALL of the documentation in \Docs\api (and its
corresponding subdirectories)? Thanks.



=====
Donnal Walter
Arkansas Children's Hospital

__________________________________________________
Do You Yahoo!?
Yahoo! Sports - live college hoops coverage
http://sports.yahoo.com/

Re: [HappyDoc-discuss] Generating documentation from non .py files?

[Doug H. <do...@he...>]

No, you haven't missed something simple; this should work.  I assume your cgi 
file is in Python, right?  That should be allowed, but currently isn't.  The 
docset assumes that only files ending in .py are Python files.  Other 
extensions should be allowed, for cases like this.  There is a policy 
question, however, about whether to always allow .cgi files or to only allow 
them if they are specified on the command line.  

Perhaps the simplest thing to do is just let the user specify additional 
filename extensions as options.  That moves the decision from us to the user.

I'd appreciate it if you would post this as a feature request.  There are a 
few bugs that I need to work on first, but this should be pretty 
straightforward to implement when I get to it.  

In the mean time, you could change the regular expression in the argument 
list to the processFiles() method in happydoclib/docset/docset_MultiFile.py.  
If you change it to also match for cgi files, you should be able to do what 
you need.  For example, r'^.*\.(py|cgi)$', works.  This would be a temporary 
solution, of course.

Doug

On Monday 21 January 2002 22:45, Lars Kellogg-Stedman wrote:
> Howdy,
>
> I'm interested in happydoc as a documentation tool, but I have thus far
> been unable to use it to create documentation for anything not ending in
> '.py'.  For instance, the following command:
>
>    happydoc script.cgi
>
> Generates no errors -- but it also generates no output.  There aren't
> any obvious command line options that seem relevant to this problem.
>
> Have I missed something simple?
>
> Thanks,
>
> -- Lars
>
>
> _______________________________________________
> HappyDoc-discuss mailing list
> Hap...@li...
> https://lists.sourceforge.net/lists/listinfo/happydoc-discuss

[HappyDoc-discuss] Generating documentation from non .py files?

[Lars Kellogg-S. <la...@la...>]

Howdy,

I'm interested in happydoc as a documentation tool, but I have thus far 
been unable to use it to create documentation for anything not ending in 
'.py'.  For instance, the following command:

   happydoc script.cgi

Generates no errors -- but it also generates no output.  There aren't 
any obvious command line options that seem relevant to this problem.

Have I missed something simple?

Thanks,

-- Lars

[HappyDoc-discuss] Re: test

[Doug H. <do...@he...>]

Second try.

On Thursday 01 November 2001 07:20, Doug Hellmann wrote:
> Testing the new list...

[Happydoc-discuss] test

[Doug H. <do...@he...>]

Testing the new list...