I document a Python project using Sphinx and the Napoleon and the autodoc extension to parse Google style docstrings. As the Google style involves specifying the type of the arguments, Sphinx automatically creates links to the documentation of the standard types in the standard library. Intersphinx However, by default it links to the 2.7 version of the documentation, whereas I want to link to a 3.x version. How can I control this behaviour?
Create type links to other version of the standard library with Sphinx napoleon
298 Views Asked by Jarno At
1
There are 1 best solutions below
Related Questions in PYTHON-SPHINX
- Display API documentation as an IPython notebook
- Proper rendering of Sphinx substitutions in httpdomain extension
- Unable to use the Sphinx Readability theme
- Error no content in "rubric" directive permitted
- Documenting python script entry (__name__ == '__main__') using sphinx
- Python Sphinx anchor on arbitrary line
- build pandas documentation from source using installed pandas rather than an inplace build
- How to use sphinx automodule and exposed functions in __init__
- Sphinx includes 'code' library descriptions where it's not supposed to
- Sphinx-doc: Search tool not returning expected results?
- Use version number in file links in Sphinx
- How to properly write cross-references to external documentation with intersphinx?
- Include a commented Python script into a Sphinx-generated documentation
- Sphinx and accordion list with CSS
- Unable to add RST reference from different file
Related Questions in SPHINX-NAPOLEON
- Custom PyCharm docstring stubs (i.e. for google docstring or numpydoc formats)
- sphinx warning: autosummary: stub file not found for the methods of the class. check your autosummary_generate settings
- Napoleon overescapes trailing underscore in parameter name leading to Unknown target name error
- Is there a standard format for documenting function-type parameters in Sphinx using sphinx.ext.napoleon?
- Sphinx-autodoc with napoleon (Google Doc String Style): Warnings and Errors about Block quotes and indention
- Using array-like as a type in napoleon without warning
- Sphinx: how to show attributes as in scipy
- Documenting class attributes with type annotations
- how to correctly add nested list in numpy docstring in combination with sphinx docstring
- Docstrings are not generated on Read the Docs with Sphinx autodoc and napoleon extensions
- Autoappend Returns None to Sphinx Documentation
- Sphinx 1.4+ and block literals in Returns with sphinx-napoleon don't work anymore
- List of class methods with Napoleon Sphinx extension using NumPyDoc style
- Sphinx fails when generating documentation for Django project
- Intersphinx Docstring Readability
Trending Questions
- UIImageView Frame Doesn't Reflect Constraints
- Is it possible to use adb commands to click on a view by finding its ID?
- How to create a new web character symbol recognizable by html/javascript?
- Why isn't my CSS3 animation smooth in Google Chrome (but very smooth on other browsers)?
- Heap Gives Page Fault
- Connect ffmpeg to Visual Studio 2008
- Both Object- and ValueAnimator jumps when Duration is set above API LvL 24
- How to avoid default initialization of objects in std::vector?
- second argument of the command line arguments in a format other than char** argv or char* argv[]
- How to improve efficiency of algorithm which generates next lexicographic permutation?
- Navigating to the another actvity app getting crash in android
- How to read the particular message format in android and store in sqlite database?
- Resetting inventory status after order is cancelled
- Efficiently compute powers of X in SSE/AVX
- Insert into an external database using ajax and php : POST 500 (Internal Server Error)
Popular Questions
- How do I undo the most recent local commits in Git?
- How can I remove a specific item from an array in JavaScript?
- How do I delete a Git branch locally and remotely?
- Find all files containing a specific text (string) on Linux?
- How do I revert a Git repository to a previous commit?
- How do I create an HTML button that acts like a link?
- How do I check out a remote Git branch?
- How do I force "git pull" to overwrite local files?
- How do I list all files of a directory?
- How to check whether a string contains a substring in JavaScript?
- How do I redirect to another webpage?
- How can I iterate over rows in a Pandas DataFrame?
- How do I convert a String to an int in Java?
- Does Python have a string 'contains' substring method?
- How do I check if a string contains a specific word?
How the Python library is linked is controlled by the intersphinx extension. Set
in
conf.pyand the links should link to the Python 3 standard library.See intersphinx docs for more information on how to use intersphinx.