Hello,
On Mon, Oct 5, 2009 at 3:32 AM, Fernando Perez <[email protected]> wrote:
> But sage doesn't use the :param: style for parameters, does it? It
> uses all-caps for informal section delimiting and regular bullet lists
> (with dashes) for parameters (this is from the 'factor' docstring):
>
> INPUT:
>
> - ``n`` - an nonzero integer
>
> - ``proof`` - bool or None (default: None)
>
> I make the precision because I interpreted the OP's question as asking
> about a project that would be using all the :param: & friends
> machinery, not just avoiding post-processing (like numpydoc).
Yep, this is what I was talking about since the previous format just
used a LaTeX \begin{itemize} and so it autoconverted to the above when
we switched over to Sphinx. It'd be better to have something more
standard, but the work just needs to be done.
> Speaking of the $x$ patch, with Ondrej we're maintaining a few useful
> such things on a public github repo:
>
> http://github.com/fperez/lacquer
>
> we hope that as these things stabilize and get cleaned up, we can
> upstream them (I'm using that extension a lot, as :math:`x` inline is
> simply intolerable for extensive markup).
Cool.
--Mike
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en
-~----------~----~----~----~------~----~------~--~---
