In my ~/shopzeus/db/pivot/convert.py file, in the run() method of my
Data2Facts class, I can write this into the docstring:
class Data2Facts(threading.Thread):
# code here...
def prepare(self,*args):
# code here...
# more code here
def run(self):
"""
Start data conversion.
You need to call :meth:`prepare` before starting the
conversion with :meth:`run`.
"""
# more code here...
This works perfectly. It places cross links in the HTML documentation.
I have another file where I'm writting a tutorial for the whole
package. From the tutorial, I would like to make references to the
API.
I can do this:
The :meth:`shopzeus.db.pivot.convert.Data2Facts.prepare` method is
used for perparing conversion from tabluar format into multi-
dimensional format.
However, I do not want to write "shopzeus.db.pivot.convert." every
time. I want to make this my current module for cross-referencing. I
have already tried this:
.. :currentmodule:: shopzeus.db.pivot.convert
The :meth:`Data2Facts.prepare` method is used for perparing conversion
from tabluar format into multi-dimensional format.
But it does not work! In the rendered HTML it is displayed in bold,
but there is no link. The sphinx build command does not give me any
warnings about invalid references. What am I doing wrong?
Thanks,
Laszlo
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
