Peter L. Soendergaard | 1 Feb 13:50 2012
Picon

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
Guenter Milde | 2 Feb 00:42 2012
Picon

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)

Peter L. Soendergaard | 2 Feb 09:50 2012
Picon

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)

Stefan Ulbrich | 6 Feb 11:54 2012
Picon
Picon

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
Guenter Milde | 7 Feb 09:10 2012
Picon

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)

David Sankel | 10 Feb 20:12 2012
Picon

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:


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/
------------------------------------------------------------------------------
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/
David Goodger | 10 Feb 20:23 2012

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)
> $< $ <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.

--

-- 
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.
David Sankel | 13 Feb 18:14 2012
Picon

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
------------------------------------------------------------------------------
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
David Sankel | 14 Feb 21:02 2012
Picon

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
------------------------------------------------------------------------------
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
multiple1902 | 16 Feb 08:03 2012
Picon

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/

Gmane