diff --git a/doc/Makefile b/doc/Makefile index a30e7043..49cda2b5 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = +SPHINXOPTS = --keep-going -W SPHINXBUILD = python -m sphinx PAPER = BUILDDIR = build @@ -10,7 +10,7 @@ BUILDDIR = build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -W +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source diff --git a/doc/source/changes.rst b/doc/source/changes.rst index 4bfef54a..e27184ec 100644 --- a/doc/source/changes.rst +++ b/doc/source/changes.rst @@ -1,6 +1,14 @@ Changelog ========= +0.4.3 +----- + +- Improved the error thrown when trying to use + :class`pfsspy.tracing.FotranTracer` without the ``streamtracer`` module + installed. +- Fixed some layout issues in the documentation. + 0.4.2 ----- diff --git a/doc/source/conf.py b/doc/source/conf.py index af9a5b64..1270005f 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -46,13 +46,12 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', + 'sphinx.ext.napoleon', 'sphinx.ext.mathjax', 'sphinx_automodapi.automodapi', - 'numpydoc', 'sphinx_gallery.gen_gallery', ] -numpydoc_show_class_members = False - +napoleon_google_docstring = False sphinx_gallery_conf = { 'examples_dirs': '../../examples', diff --git a/requirements/docs.txt b/requirements/docs.txt index f04e18e4..1c43ba7a 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -3,8 +3,6 @@ graphviz pillow sphinx-automodapi>=0.10 -numpydoc -sunpy_sphinx_theme sphinx_rtd_theme sphinx-gallery sphinx>2