Hi everybody,

thanks for sphinx, first of all. I am creating documentation of yade
simulation software, which has hand-written and autogenerated part
(both sphinx, of course). The auto-generated part documents pure-
python functions/classes and also (many) c++ classes exposed via
boost::python.

Class data members often have default values and some physical
dimension (units); I have custom roles for documenting that inside the
docstring (:ydefault:`-1`, for instance), so it looks like
https://www.yade-dem.org/sphinx/yade.wrapper.html#yade.wrapper.CpmMat
. Data members are rendered as HTML definition list, where term is the
attribute name and the rest is in the description part; I would like
the default value and dimensions (and perhaps other) be in the term
(bold) part of the list, like "dmgTau [s] (default -1)" and then as
the description "Characteristic time for normal viscosity."

Can I get some help on that?

Cheers, Václav

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

Reply via email to