I am currently documenting a Django project and ran into the problem
of easy cross referencing between two modules. I am using both the
autodoc and intersphinx modules. For example, my docstring in one
module contains 'please see :py:class:`SomeModel`; where 'SomeModel`
is a class in another module. For my own sanity, I don't want to have
to include the full class path to 'SomeModel' in the docstring (ie.
see :py:class:`some.path.SomeModel`). In my search for an easy
solution, I came across the following thread:

http://groups.google.com/group/sphinx-dev/browse_thread/thread/2fa7a5fcaecfe44e/5488997d0a9c7605

I have tested the given solution and verified that it works, but I
cannot find the Sphinx documentation that defines the 'fuzzy search'
cross reference method (the leading '.' [dot]). My question is this:
is the solution purposed in the URL above the correct way to flag a
cross reference as 'fuzzy', or is there a more appropriate way of
accomplishing 'fuzzy' references? If the URL describes the appropriate
solution, where is the documentation describing it (I cannot seem to
find it in the Sphinx documentation).

Thanks in advance,
Adam

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@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.

Reply via email to