Hi, I have a few questions regarding parameters list syntax. 1. Is the consolidated fields syntax supported?
For me, it works in python functions. If I have c++ function where I mangle the docstring with callback functions, I don't get the desired result. e.g. https://www.yade-dem.org/sphinx/yade.utils.html#yade._utils.getViscoelasticFromSpheresInteraction (a f++ function) doesn't work, although the string looks exactly the same (after mangled by callback) as python docstring in https://www.yade-dem.org/sphinx/yade.utils.html#yade.utils.wall (which is a pure python function) The source for the docs are http://bazaar.launchpad.net/~yade-dev/yade/trunk/annotate/head%3A/py/_utils.cpp#L449 and http://bazaar.launchpad.net/~yade-dev/yade/trunk/annotate/head%3A/py/utils.py#L207 respectively. The c++ function is mangled like this (sorry for longer text, there is a point below): ''' Get viscoelastic interaction parameters from analytical solution of a pair spheres collision problem. :Parameters: `m` : float sphere mass `tc` : float collision time `en` : float normal restitution coefficient `es` : float tangential restitution coefficient. :return: dict with keys: kn : float normal elastic coefficient computed as: .. math:: k_n=\frac{m}{t_c^2}\left(\pi^2+(\ln e_n)^2\right) cn : float normal viscous coefficient computed as: .. math:: c_n=-\frac{2m}{t_c}\ln e_n [...] ''' the parameters fields look the same as for the wall function in python, but is rendered differently. 2. For math syntax: as you see in the above docstring, the .. math:: lines are unindented. If they are indented to match indentation of the surrounding text, they are not rendered as formulas, but literally (i.e. I see the ".. math :: k_n=\frac"... in the HTML page. In python docstrings, I see much more libral behavior. Can the cause be the same as for the consolidated lists issue above? 3. Are consolidate fields a feature that exists only for backwards compat with epydoc and is to be avoided otherwise? Thanks, Vaclav -- 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.
