From 5b2cbcf006f60c0c520c40a44b30586ba089ac2d Mon Sep 17 00:00:00 2001 From: Ian Fan Date: Wed, 26 Oct 2022 22:31:05 +0100 Subject: [PATCH] Update `sphinxcontrib-napoleon` to `sphinx.ext.napoleon` --- README.md | 2 +- docs/conf.py | 5 +---- setup.py | 1 - 3 files changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7af6766..eacef50 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ pip install -e .[dev] # install extra tools useful for development We follow a PEP8 code style with line length 88, and typically follow the [Google Code Style Guide](http://google.github.io/styleguide/pyguide.html), but defer to PEP8 where they conflict. We use the `black` autoformatter to avoid arguing over formatting. Docstrings follow the Google docstring convention defined [here](http://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings), -with an extensive example in the [Sphinx docs](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html). +with an extensive example in the [Sphinx docs](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html). All PRs must pass linting via the `ci/code_checks.sh` script. It is convenient to install this as a commit hook: diff --git a/docs/conf.py b/docs/conf.py index fecdd1a..f286919 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,19 +22,16 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - "sphinxcontrib.napoleon", "sphinx.ext.autodoc", "sphinx_autodoc_typehints", "sphinx.ext.autosummary", "sphinx.ext.mathjax", + "sphinx.ext.napoleon", "sphinx.ext.viewcode", "sphinx_rtd_theme", ] autodoc_mock_imports = ["mujoco_py"] -napoleon_google_docstring = True -napoleon_numpy_docstring = False - # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/setup.py b/setup.py index be870e4..eca507e 100644 --- a/setup.py +++ b/setup.py @@ -123,7 +123,6 @@ def get_readme() -> str: "sphinx", "sphinx-autodoc-typehints", "sphinx-rtd-theme", - "sphinxcontrib-napoleon", ]