restructuredtext

Multi-line description of a parameter description in python docstring

by

Good research effort from the Original Poster. It is a surprise that the canonical sphinx documentation does not give a multi-line example on params, despite the fact that multi-line document is inevitable due to the 79-character guideline in PEP8. In practice, considering that your parameter name itself is typically a word or even longer snake_case_words, … Read more

How would I cross-reference a function generated by autodoc in Sphinx?

by

You don’t need to add labels. In order to refer to a Python class, method, or other documented object, use the markup provided by the Python domain. For example, the following defines a cross-reference to the mymethod method: :py:meth:`mymodule.MyClass.mymethod` Or even simpler (since the Python domain is the default): :meth:`mymodule.MyClass.mymethod` The documentation of TextWrapper.wrap that … Read more

How can I link/reference another reST file in the documentation?

by

To create links between different reStructuredText (.rst) files you can use the inline markup provided by sphinx. See the documentation under the heading Cross-referencing documents on top of the file you define its label .. _my-reference-label: then you can link to it from other documents using :ref:`my-reference-label`. I do not believe you need to use … Read more