User discussion for the docutils project.

Nicola Larosa | 1 Nov 2005 08:31

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 2005 09:52

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 2005 11:01

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 2005 15:30

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 2005 16:16

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 2005 16:09

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 2005 00:53

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 2005 03:42

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 2005 06:28

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 2005 09:18

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)

Group

gmane.text.docutils.user.

Project Web Page

User discussion for the docutils project.

Search Archive

Page

1 | 2 | 3 | 4

Articles in period: 39

November 2005

Language

Change language

Options

Current view: Threads only / Showing only 20 lines / Not hiding cited text.
Change to All messages, whole messages, or hide cited text.

Post a message
NNTP Newsgroup
Classic Gmane web interface
XML

XML

RSS Feed
List Information

About Gmane

Recent entries

Fwd: Problem: rst2latex --use-bibtex works but produces double referen (15 May 2013)
Fwd: custom directive: publish html and latex2e differently (14 May 2013)
Problem: rst2latex --use-bibtex works but produces double references. (13 May 2013)
custom directive: publish html and latex2e differently (8 May 2013)
why i can't use the search function in restructured text? (6 May 2013)
replacement text for enumeration sequence initializer (2 May 2013)
inserting generated reST into a reST document (24 Apr 2013)
draft-comments (19 Apr 2013)
[reStructuredTex] How to right align a Grid / Simple Table. (18 Apr 2013)
question about custom LatexWriter (11 Apr 2013)
:code: option in include directive does not cause syntax highlighting (10 Apr 2013)
bold fixed-space text and bold italic text (8 Apr 2013)
Custom indirect hyperlinks (6 Apr 2013)
ReST from inside a program? (4 Apr 2013)
Dead link on mailing lists page (3 Apr 2013)
Import bug in docutils/parsers/rst/state.py (18 Mar 2013)
docutils Causing Python 2.7.3 Dumps Under Cgywin? (17 Mar 2013)
Change in default location of html4css1.css in recent snapshots? (12 Mar 2013)
Resolve Substitutions in RestructedText (11 Mar 2013)
Cloning option_list format (25 Feb 2013)
HTML embed tag for SVG images? (19 Feb 2013)

Archives

28	May 2013
41	April 2013
39	March 2013
24	February 2013
32	January 2013
30	December 2012
12	November 2012
21	October 2012
24	September 2012
11	August 2012
14	July 2012
23	June 2012
53	May 2012
39	April 2012
24	March 2012
32	February 2012
23	January 2012
19	December 2011
60	November 2011
117	October 2011
12	September 2011
8	August 2011
14	July 2011
11	June 2011
27	May 2011
45	April 2011
64	March 2011
24	February 2011
29	January 2011
32	December 2010
15	November 2010
37	October 2010
152	September 2010
40	August 2010
20	July 2010
49	June 2010
30	May 2010
43	April 2010
58	March 2010
55	February 2010
33	January 2010
62	December 2009
31	November 2009
85	October 2009
93	September 2009
51	August 2009
22	July 2009
37	June 2009
110	May 2009
89	April 2009
83	March 2009
33	February 2009
50	January 2009
86	December 2008
38	November 2008
42	October 2008
59	September 2008
82	August 2008
25	July 2008
62	June 2008
56	May 2008
45	April 2008
51	March 2008
88	February 2008
57	January 2008
32	December 2007
27	November 2007
17	October 2007
7	September 2007
21	August 2007
25	July 2007
79	June 2007
69	May 2007
96	April 2007
124	March 2007
60	February 2007
92	January 2007
52	December 2006
29	November 2006
102	October 2006
58	September 2006
65	August 2006
118	July 2006
65	June 2006
86	May 2006
67	April 2006
56	March 2006
39	February 2006
50	January 2006
26	December 2005
39	November 2005
115	October 2005
78	September 2005
150	August 2005
65	July 2005
97	June 2005
106	May 2005
165	April 2005
65	March 2005
56	February 2005
31	January 2005
43	December 2004
131	November 2004
62	October 2004
37	September 2004
26	August 2004
24	July 2004
82	June 2004
86	May 2004
43	April 2004
10	March 2004
39	February 2004
60	January 2004
33	December 2003
34	November 2003
20	October 2003
44	September 2003
71	August 2003
126	July 2003
160	June 2003
160	May 2003
62	April 2003
74	March 2003
34	February 2003
43	January 2003
58	December 2002
16	November 2002

Design

Zawodny | Right Menu | Left Menu

Your Own Design

Paste the URL of your CSS below. Download CSS template