I tried all the possible options I found but none of them worked yet.
Given something like:
a.py:
# this variable is used for x
A = 10
# this variables is used for y
B = 42
is there a way to tell Sphinx to detect the docstrings for these
variables and output the right thing?
Thanks,
A colon has to follow the hash like #: so in order for Sphinx to pick it up as
a doc string for that attribute.
Am 16.03.2012 um 11:11 schrieb Andrea Crotti andrea.crott...@gmail.com:
I tried all the possible options I found but none of them worked yet.
Given something like:
a.py:
#
On 03/16/2012 10:31 AM, Daniel Neuhäuser wrote:
A colon has to follow the hash like #: so in order for Sphinx to pick it up as
a doc string for that attribute.
Ah great thanks, just to check, is it written anywhere? Because it's not
really trivial unless one knows it already..
--
You
Am 16. März 2012 11:34 schrieb Andrea Crotti andrea.crott...@gmail.com:
On 03/16/2012 10:31 AM, Daniel Neuhäuser wrote:
A colon has to follow the hash like #: so in order for Sphinx to pick it
up as a doc string for that attribute.
Ah great thanks, just to check, is it written anywhere?
I have to say that the doc is not very clear: ...'documentation can either be
put into a special-formatted comment'... but the colon is not mentioned. It is
easy to miss the colon after the hash in the example in that section
Rob
Op 16 mrt 2012, om 11:46 heeft Sebastian Wiesner het volgende
