Merge pull request #7860 from tk0miya/7841_update_docs

doc: Add modname separator tip for autodoc (refs: #7841)
This commit is contained in:
Takeshi KOMIYA
2020-06-26 02:05:05 +09:00
committed by GitHub

View File

@@ -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