doc: Add modname separator tip for autodoc (refs: sphinx-doc#7841)

tk0miya · Jun 21, 2020 · 3440f86 · 3440f86
1 parent 275d93b
commit 3440f86
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 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

diff --git a/sphinx/directives/code.py b/sphinx/directives/code.py
@@ -155,7 +155,7 @@ def run(self) -> List[Node]:
 
         literal = nodes.literal_block(code, code)  # type: Element
         if 'linenos' in self.options or 'lineno-start' in self.options:
-            literal['linenos'] = True
+            literal['linenos'] = 'inline'
         literal['classes'] += self.options.get('class', [])
         literal['force'] = 'force' in self.options
         if self.arguments:
@@ -442,7 +442,7 @@ def run(self) -> List[Node]:
                 retnode['language'] = self.options['language']
             if ('linenos' in self.options or 'lineno-start' in self.options or
                     'lineno-match' in self.options):
-                retnode['linenos'] = True
+                retnode['linenos'] = 'inline'
             retnode['classes'] += self.options.get('class', [])
             extra_args = retnode['highlight_args'] = {}
             if 'emphasize-lines' in self.options: