We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 6378d48 commit 2b5bb79Copy full SHA for 2b5bb79
doc/devel/document.rst
@@ -317,7 +317,10 @@ target is unambiguous you can simply leave them out:
317
318
`.LineCollection`
319
320
-and the link still works: `.LineCollection`.
+and the link still works: `.LineCollection`. Note that you should typically include
321
+the leading dot. It tells Sphinx to look for the given name in the whole project.
322
+See also the explanation at `Sphinx: Cross-referencing Python objects
323
+<https://www.sphinx-doc.org/en/master/usage/domains/python.html#cross-referencing-python-objects>`_.
324
325
If there are multiple code elements with the same name (e.g. ``plot()`` is a
326
method in multiple classes), you'll have to extend the definition:
0 commit comments