From 42f29b6acf9661c34a44078b49de9e32a447def4 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 21 Jun 2020 23:28:03 +0900 Subject: [PATCH] doc: Add modname separator tip for autodoc (refs: #7841) --- doc/usage/extensions/autodoc.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/usage/extensions/autodoc.rst b/doc/usage/extensions/autodoc.rst index ec1d6c9b5..150b62c4d 100644 --- a/doc/usage/extensions/autodoc.rst +++ b/doc/usage/extensions/autodoc.rst @@ -280,6 +280,12 @@ inserting them into the page source under a suitable :rst:dir:`py:module`, .. versionadded:: 1.3 + * As a hint to autodoc extension, you can put a ``::`` separator in between + module name and object name to let autodoc know the correct module name if + it is ambiguous. :: + + .. autoclass:: module.name::Noodle + .. rst:directive:: autofunction autodecorator