module sphinxext.documentation_link
¶
Short summary¶
module pyquickhelper.sphinxext.documentation_link
Automated link to documentation.
Functions¶
function |
truncated documentation |
---|---|
Returns a url about Python documentation. |
Documentation¶
Automated link to documentation.
- pyquickhelper.sphinxext.documentation_link.python_link_doc(m, o=None, format='rst')[source]¶
Returns a url about Python documentation.
<<<
from pyquickhelper.sphinxext import python_link_doc print(python_link_doc("io"))
>>>
`io <https://docs.python.org/3/library/io.html>`_
- Parameters:
m – Python module
o – function name or class name
format – ‘rst’ or ‘raw’
- Returns:
str or tuple