diff --git a/docs/contributing/sphinx.rst b/docs/contributing/sphinx.rst --- a/docs/contributing/sphinx.rst +++ b/docs/contributing/sphinx.rst @@ -1,9 +1,11 @@ .. _sphinx-gotchas: Sphinx gotchas -============== +=========== + +Here is a list of common gotchas when formatting Python docstrings for `Sphinx `_ +and the `Napoleon `_ style. -Here is a list of common gotchas when formatting Python docstrings for `Sphinx `_ and the `Napoleon `_ style. Sphinx ------