Changeset View

Standalone View

	.. _sphinx-gotchas:			.. _sphinx-gotchas:

	Sphinx gotchas			Sphinx gotchas
	==============			==============

	Here is a list of common gotchas when formatting Python docstrings for `Sphinx <https://www.sphinx-doc.org/en/stable/>`_ and the `Napoleon <https://www.sphinx-doc.org/en/stable/ext/napoleon.html>`_ style.			Here is a list of common gotchas when formatting Python docstrings for `Sphinx <https://www.sphinx-doc.org/en/stable/>`_
				and the `Napoleon <https://www.sphinx-doc.org/en/stable/ext/napoleon.html>`_ style.


	Sphinx			Sphinx
	------			------

	Lists			Lists
	+++++			+++++

	All sorts of `lists <https://www.sphinx-doc.org/en/stable/rest.html#lists-and-quote-like-blocks>`_			All sorts of `lists <https://www.sphinx-doc.org/en/stable/rest.html#lists-and-quote-like-blocks>`_
	▲ Show 20 Lines • Show All 224 Lines • Show Last 20 Lines