From 13f16cbbac4f8b7d87a80ed8786f5e68556a7c2c Mon Sep 17 00:00:00 2001 From: Britton Smith Date: Mon, 8 Oct 2018 16:53:25 -0700 Subject: [PATCH] Add napoleon extension and error out on warnings in docs build. --- doc/Makefile | 4 ++-- doc/source/conf.py | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/Makefile b/doc/Makefile index ed145c38..3aad8303 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = +SPHINXOPTS = -W SPHINXBUILD = sphinx-build SPHINXPROJ = yt_astro_analysis SOURCEDIR = source @@ -17,4 +17,4 @@ help: # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/doc/source/conf.py b/doc/source/conf.py index 9558c0f1..63d420f1 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -42,7 +42,8 @@ 'sphinx.ext.autodoc', 'sphinx.ext.imgmath', 'sphinx.ext.autosummary', - 'sphinx.ext.intersphinx' + 'sphinx.ext.intersphinx', + 'sphinx.ext.napoleon' ] intersphinx_mapping = \