Merge pull request #7860 from tk0miya/7841_update_docs

doc: Add modname separator tip for autodoc (refs: #7841)
sphinx-doc · Jun 25, 2020 · 03e85df · 03e85df
2 parents 275d93b + 42f29b6
commit 03e85df
Showing 1 changed file with 6 additions and 0 deletions.
diff --git 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