Nicola Larosa | 1 Nov 08:31 2005
Picon

Re: Extracting documentation from source files

> How I extract all those docs strings and presents them in some nice form.
> Set of html files is good enough. 

Try Epydoc: http://epydoc.sourceforge.net/ . It supports ReST.

--

-- 
Nicola Larosa - nico <at> tekNico.net

If there's one thing that religions are good at, it's giving people
axioms, and axioms don't have to be rational. You can make up the
craziest religion you can think of, and people will still follow it,
because it makes them function better. -- Phillip J. Eby, August 2005

-------------------------------------------------------
This SF.Net email is sponsored by the JBoss Inc.
Get Certified Today * Register for a JBoss Training Course
Free Certification Exam for All Training Attendees Through End of 2005
Visit http://www.jboss.com/services/certification for more information
Michael Foord | 1 Nov 09:52 2005

Re: Re: Extracting documentation from source files

Nicola Larosa wrote:
>>How I extract all those docs strings and presents them in some nice form.
>>Set of html files is good enough. 
> 
> 
> Try Epydoc: http://epydoc.sourceforge.net/ . It supports ReST.
> 

Pudge is an interesting new project as well - it produces very nice
results and will rapidly become more fully featured than epydoc (which
doesn't seem to be getting any more development ??)

http://pudge.lesscode.org

Fuzzyman
http://www.voidspace.org.uk/python

-------------------------------------------------------
This SF.Net email is sponsored by the JBoss Inc.
Get Certified Today * Register for a JBoss Training Course
Free Certification Exam for All Training Attendees Through End of 2005
Visit http://www.jboss.com/services/certification for more information
Roman Yakovenko | 1 Nov 11:01 2005
Picon

Re: Extracting documentation from source files

Michael Foord <mike <at> pcblokes.com> wrote>
>Nicola Larosa wrote:
>>>How I extract all those docs strings and presents them in some nice form.
>>>Set of html files is good enough.
>>
>> Try Epydoc: http://epydoc.sourceforge.net/ . It supports ReST.

>Pudge is an interesting new project as well - it produces very nice
>results and will rapidly become more fully featured than epydoc (which
>doesn't seem to be getting any more development ??)
>http://pudge.lesscode.org

It seems so.

But I would like to get solution that does not force me to leave docutils.
I saw modulereader.py and  extractor.py but I can get them work.
I use docutils 0.3.9

Thanks for link.

>Fuzzyman

Roman Yakovenko

-------------------------------------------------------
This SF.Net email is sponsored by the JBoss Inc.
Get Certified Today * Register for a JBoss Training Course
Free Certification Exam for All Training Attendees Through End of 2005
Visit http://www.jboss.com/services/certification for more information
(Continue reading)

Daniel Serodio | 1 Nov 15:30 2005
Picon

Numbered headings

How can I make my headings numbered? I'd like to have an output like the
following:

1. First level
1.1. Second level
1.2. Another at second level
2. Another at first level

Thanks in advance,
Daniel Serodio

-------------------------------------------------------
This SF.Net email is sponsored by the JBoss Inc.
Get Certified Today * Register for a JBoss Training Course
Free Certification Exam for All Training Attendees Through End of 2005
Visit http://www.jboss.com/services/certification for more information
Felix Wiemann | 1 Nov 16:16 2005
Picon
Picon

Re: Numbered headings

Daniel Serodio wrote:

> How can I make my headings numbered? I'd like to have an output like the
> following:
>
> 1. First level
> 1.1. Second level
> 1.2. Another at second level
> 2. Another at first level

You can use the sectnum directive:
<http://docutils.sf.net/docs/ref/rst/directives.html#sectnum

--

-- 
For private mail please ensure that the header contains 'Felix Wiemann'.

"the number of contributors [...] is strongly and inversely correlated with the
number of hoops each project makes a contributing user go through."      -- ESR

-------------------------------------------------------
SF.Net email is sponsored by:
Tame your development challenges with Apache's Geronimo App Server. Download
it for free - -and be entered to win a 42" plasma tv or your very own
Sony(tm)PSP.  Click here to play: http://sourceforge.net/geronimo.php
Udo Wendler | 1 Nov 16:09 2005
Picon

Re: Emacs stuff revamp and new document

Hallo, in docs/user/emacs.txt (svn revision 3992) is:

> Or add this at the end of your documents:
> 
>    ..
>       Local Variables:
>       mode: rst
>

On my Emacs (Aquamacs version 0.9.3 on Apple MacOS-X) it produce an
error.  It goes when:

>    ..
>       Local Variables:
>       mode: rst
>       End:

Sorry for my little english. Thanks, I like rst.el :-)
Udo Wendler

-------------------------------------------------------
SF.Net email is sponsored by:
Tame your development challenges with Apache's Geronimo App Server. Download
it for free - -and be entered to win a 42" plasma tv or your very own
Sony(tm)PSP.  Click here to play: http://sourceforge.net/geronimo.php
David Goodger | 2 Nov 00:53 2005

Re: Re: Extracting documentation from source files

[Roman Yakovenko]
> But I would like to get solution that does not force me to leave docutils.

There is no such solution.

> I saw modulereader.py and extractor.py but I can get them work.

Those are probably out of date.

--
David Goodger <http://python.net/~goodger>
David Goodger | 2 Nov 03:42 2005

Re: Re: Emacs stuff revamp and new document

[Udo Wendler]
> On my Emacs (Aquamacs version 0.9.3 on Apple MacOS-X) it produce an
> error.  It goes when:
>
>>   ..
>>      Local Variables:
>>      mode: rst
>>      End:

Thanks, it's fixed in SVN now.

--
David Goodger <http://python.net/~goodger>
Roman Yakovenko | 2 Nov 06:28 2005
Picon

Re: Re: Extracting documentation from source files

On 11/2/05, David Goodger <goodger <at> python.org> wrote:
> [Roman Yakovenko]
> > But I would like to get solution that does not force me to leave docutils.
>
> There is no such solution.

:-(

> > I saw modulereader.py and extractor.py but I can get them work.
>
> Those are probably out of date.

:-(

> --
> David Goodger <http://python.net/~goodger>
>
>
>

-------------------------------------------------------
SF.Net email is sponsored by:
Tame your development challenges with Apache's Geronimo App Server. Download
it for free - -and be entered to win a 42" plasma tv or your very own
Sony(tm)PSP.  Click here to play: http://sourceforge.net/geronimo.php
Michael Foord | 3 Nov 09:18 2005

Re: Re: Extracting documentation from source files

Roman Yakovenko wrote:
>>Nicola Larosa <nico <at> tekNico.net> wrote
>>
>>>How I extract all those docs strings and presents them in some nice form.
>>>Set of html files is good enough. 
> 
> 
>>Try Epydoc: http://epydoc.sourceforge.net/ . It supports ReST.
> 
> 
> 
> 1. I prefer not to leave docutils

Why ?
Both pudge and epydoc will read docstrings written in reST format and
use docutils to create documentation.

There seems to be no effort *within* the docutils project to create a
competitor to these two - which IMHO is right. Seeing as pudge is
getting active development my advice would be to use that.

All the best,

Fuzzyman
http://www.voidspace.org.uk/python

> 2. I tried moduleparse.py and extractor.py and it seems that they does not 
>    work together. 
> 
> Thanks
(Continue reading)


Gmane