User discussion for the docutils project.

Latex in $ ... $

Hi everyone,

I just subscribed to this list, so I am not sure if this has been
discussed before.

I am adapting reST to work for Matlab headers for two open source
toolboxes that I am managing, LTFAT and AMToolbox.

As many of my constributors are mathematicians, or are used to working
with Latex, it is much more natural for them to use the $...$ markup
instead of the :math:`...` markup for inline formulas.

Currently I solve this by a simple Python preprocessing script that
convert pairs of $ into the correct role, but I was wondering if there
was a more clean solution to achieve this.

Cheers,
Peter.

------------------------------------------------------------------------------
Keep Your Developer Skills Current with LearnDevNow!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-d2d

headers

Guenter Milde | 2 Feb 00:42

Re: Latex in $ ... $

On 2012-02-01, Peter L. Soendergaard wrote:
> Hi everyone,

> I just subscribed to this list, 

welcome

> so I am not sure if this has been discussed before.

> I am adapting reST to work for Matlab headers for two open source
> toolboxes that I am managing, LTFAT and AMToolbox.

> As many of my constributors are mathematicians, or are used to working
> with Latex, it is much more natural for them to use the $...$ markup
> instead of the :math:`...` markup for inline formulas.

> Currently I solve this by a simple Python preprocessing script that
> convert pairs of $ into the correct role, but I was wondering if there
> was a more clean solution to achieve this.

You can define a "default role" like::

  .. default-role:: math

and then write::

  As `1+1=2`, ...

without the math pre- or postfix.

(Continue reading)

headers

Peter L. Soendergaard | 2 Feb 09:50

Re: Latex in $ ... $

Dear Günter,

thank you for your kind answer.

> > As many of my constributors are mathematicians, or are used to working
> > with Latex, it is much more natural for them to use the $...$ markup
> > instead of the :math:`...` markup for inline formulas.
> 
> > Currently I solve this by a simple Python preprocessing script that
> > convert pairs of $ into the correct role, but I was wondering if there
> > was a more clean solution to achieve this.
> 
> You can define a "default role" like::
> 
>   .. default-role:: math
>   
> and then write::
> 
>   As `1+1=2`, ...
> 
> without the math pre- or postfix.

I am currently using the default role for literal, so people don't have
to type ``...`` for inline code, this markup appears even more often
than the math. 
> 
> There is no easy way to define new "special characters" and there are
> currently no plans to use $math$ markers in rst.
> 
> Hope this helps a bit,

(Continue reading)

headers

Stefan Ulbrich | 6 Feb 11:54

Signature introspection from docstring

Hello List,

I want to expose a Python module via XML-RPC to a C++ program and want my server to provide function
signatures with type information. 
The signature should be automatically generated and all methods in the module are extensively documented
with ":param:" and ":type:".
For now, I use regular expressions to extract the description but I wonder if I can also use the docutils. Can
anybody give me a hint 
at which part of docutils to look if this is possible? 

Best,
Stefan
------------------------------------------------------------------------------
Try before you buy = See our experts in action!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-dev2

headers

Guenter Milde | 7 Feb 09:10

Re: Signature introspection from docstring

On 2012-02-06, Stefan Ulbrich wrote:
> Hello List,

> I want to expose a Python module via XML-RPC to a C++ program and want
> my server to provide function signatures with type information.  The
> signature should be automatically generated and all methods in the
> module are extensively documented with ":param:" and ":type:". For now,
> I use regular expressions to extract the description but I wonder if I
> can also use the docutils. Can anybody give me a hint at which part of
> docutils to look if this is possible? 

Have a look at Sphinx__ and its extensions.

__ http://sphinx.pocoo.org/

Günter

------------------------------------------------------------------------------
Keep Your Developer Skills Current with LearnDevNow!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-d2d
_______________________________________________
Docutils-users mailing list
Docutils-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/docutils-users

Please use "Reply All" to reply to the list.

(Continue reading)

headers

David Sankel | 10 Feb 20:12

Command line definitions

Hello Everyone,

I am attempting to create some rst documentation that is highly modularized. One repository will often pull in rst files from another repository, but the locations of these repositories relative to each-other is going to change based on how someone sets up their computer.

The way I'd usually set this up is with a local-config.mk Makefile with something like:

OTHERREPO_PATH = blah

PYTHONSCRIPTS_PATH = C:/Python27/Scripts/

And then the Makefile will have:

include local-config.mk

all: build/thisrepo.html

build/%.html : src/%.rst

python $(PYTHONSCRIPTS_PATH)/rst2html.py -DOTHERREPO_PATH=$(OTHERREPO_PATH) $< $ <at>

With src/thisrepo.rst having something like:

.. include:: $OTHERREPO_PATH/src/otherthing.rst

I put the mechanism I wish was there in bold font. Is there a canonical way to do what I'm looking for? Perhaps there is a way to add different path's to the <include> style?

Thanks in advance,

David

--
David Sankel
Sankel Software
www.sankelsoftware.com
585 617 4748 (Office)

------------------------------------------------------------------------------
Virtualization & Cloud Management Using Capacity Planning
Cloud computing makes use of virtualization - but cloud computing 
also focuses on allowing computing to be delivered as a service.
http://www.accelacomm.com/jaw/sfnl/114/51521223/

headers

David Goodger | 10 Feb 20:23

Re: Command line definitions

On Fri, Feb 10, 2012 at 14:12, David Sankel <camior <at> gmail.com> wrote:
> Hello Everyone,
>
> I am attempting to create some rst documentation that is highly modularized.
> One repository will often pull in rst files from another repository, but the
> locations of these repositories relative to each-other is going to change
> based on how someone sets up their computer.
>
> The way I'd usually set this up is with a local-config.mk Makefile with
> something like:
>
> OTHERREPO_PATH = blah
> PYTHONSCRIPTS_PATH = C:/Python27/Scripts/
>
>
> And then the Makefile will have:
>
> include local-config.mk
>
> all: build/thisrepo.html
>
> build/%.html : src/%.rst
> python $(PYTHONSCRIPTS_PATH)/rst2html.py -DOTHERREPO_PATH=$(OTHERREPO_PATH)
> $< $@
>
> With src/thisrepo.rst having something like:
>
> .. include:: $OTHERREPO_PATH/src/otherthing.rst
>
>
> I put the mechanism I wish was there in bold font. Is there a canonical way
> to do what I'm looking for? Perhaps there is a way to add different path's
> to the <include> style?

Docutils doesn't have a mechanism for such variable interpolation.
Perhaps Sphinx does?

I suggest using a templating system as a pre-processor.

--

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

------------------------------------------------------------------------------
Virtualization & Cloud Management Using Capacity Planning
Cloud computing makes use of virtualization - but cloud computing 
also focuses on allowing computing to be delivered as a service.
http://www.accelacomm.com/jaw/sfnl/114/51521223/
_______________________________________________
Docutils-users mailing list
Docutils-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/docutils-users

Please use "Reply All" to reply to the list.

headers

David Sankel | 13 Feb 18:14

Re: Command line definitions

On Fri, Feb 10, 2012 at 12:23 PM, David Goodger <goodger <at> python.org> wrote:

On Fri, Feb 10, 2012 at 14:12, David Sankel <camior <at> gmail.com> wrote:
> Hello Everyone,
>
> I am attempting to create some rst documentation that is highly modularized.
> One repository will often pull in rst files from another repository, but the
> locations of these repositories relative to each-other is going to change
> based on how someone sets up their computer.
>
> The way I'd usually set this up is with a local-config.mk Makefile with
> something like:
>
> OTHERREPO_PATH = blah
> PYTHONSCRIPTS_PATH = C:/Python27/Scripts/
>
>
> And then the Makefile will have:
>
> include local-config.mk
>
> all: build/thisrepo.html
>
> build/%.html : src/%.rst
> python $(PYTHONSCRIPTS_PATH)/rst2html.py -DOTHERREPO_PATH=$(OTHERREPO_PATH)
> $< $ <at>
>
> With src/thisrepo.rst having something like:
>
> .. include:: $OTHERREPO_PATH/src/otherthing.rst
>
>
> I put the mechanism I wish was there in bold font. Is there a canonical way
> to do what I'm looking for? Perhaps there is a way to add different path's
> to the <include> style?

Docutils doesn't have a mechanism for such variable interpolation.
Perhaps Sphinx does?

I suggest using a templating system as a pre-processor.

Actually what I ended up doing is use another level of indirection on the include directive, essentially generating a rst file that just includes another one. This worked well and has the benefit of not requiring the addition of another tool to the toolchain.

build/%.rst :

echo .. include:: ../$< > $ <at>

build/%.html : src/%.rst build/otherrepo.rst

python $(PYTHONSCRIPTS_PATH)/rst2html.py $< $ <at>

build/otherrepo.rst : $(OTHERREPO)/thing.rst

With src/thisrepo.rst having something like:

.. include:: ../build/otherrepo.rst

Thanks,

David
--
David Sankel
Sankel Software
www.sankelsoftware.com
585 617 4748 (Office)

------------------------------------------------------------------------------
Try before you buy = See our experts in action!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-dev2

headers

David Sankel | 14 Feb 21:02

target-notes

Hello everyone,

I want target-notes to be enabled when I generate a tex version of my rst file and I want it to be disabled when I generate the html variant. Is there a way to do this without having a different rst file for my tex output and my html output?

Thanks in advance,

David

--
David Sankel
Sankel Software
www.sankelsoftware.com
585 617 4748 (Office)

------------------------------------------------------------------------------
Keep Your Developer Skills Current with LearnDevNow!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-d2d

headers

multiple1902 | 16 Feb 08:03

Reporting Dead link on Docutils FAQ page

Hi. The link "Python Desktop Server" pointing to
http://pyds.muensterland.org/ seems to be a dead one on the following
page:

http://docutils.sourceforge.net/FAQ.html#are-there-any-weblog-blog-projects-that-use-restructuredtext-syntax

No suggested alternative url is found, sadly.

p.s. I'm not a subscriber to this mail-list.

multiple1902
Feb 16, 2012.

------------------------------------------------------------------------------
Virtualization & Cloud Management Using Capacity Planning
Cloud computing makes use of virtualization - but cloud computing 
also focuses on allowing computing to be delivered as a service.
http://www.accelacomm.com/jaw/sfnl/114/51521223/

42	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

Mon	Tue	Wed	Thu	Fri	Sat	Sun

		1	2	3	4	5
6	7	8	9	10	11	12
13	14	15	16	17	18	19
20	21	22	23	24	25	26
27	28	29