diff options
| -rw-r--r-- | .circleci/config.yml | 2 | ||||
| -rw-r--r-- | azure-pipelines.yml | 2 | ||||
| -rw-r--r-- | doc/source/_templates/autosummary/base.rst | 14 | ||||
| -rw-r--r-- | doc/source/conf.py | 2 |
4 files changed, 17 insertions, 3 deletions
diff --git a/.circleci/config.yml b/.circleci/config.yml index d84b762c2..92987ef8e 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -21,7 +21,7 @@ jobs: python3 -m venv venv ln -s $(which python3) venv/bin/python3.6 . venv/bin/activate - pip install cython sphinx==2.1.2 matplotlib ipython + pip install cython sphinx==2.2.0 matplotlib ipython sudo apt-get update sudo apt-get install -y graphviz texlive-fonts-recommended texlive-latex-recommended texlive-latex-extra texlive-generic-extra latexmk texlive-xetex diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 10c6fd277..52b4818d6 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -88,7 +88,7 @@ jobs: displayName: 'Install tools' - script: | python -m pip install -r test_requirements.txt - python -m pip install vulture docutils sphinx==2.1.2 numpydoc + python -m pip install vulture docutils sphinx==2.2.0 numpydoc displayName: 'Install dependencies; some are optional to avoid test skips' - script: /bin/bash -c "! vulture . --min-confidence 100 --exclude doc/,numpy/distutils/ | grep 'unreachable'" displayName: 'Check for unreachable code paths in Python modules' diff --git a/doc/source/_templates/autosummary/base.rst b/doc/source/_templates/autosummary/base.rst new file mode 100644 index 000000000..0331154a7 --- /dev/null +++ b/doc/source/_templates/autosummary/base.rst @@ -0,0 +1,14 @@ +{% if objtype == 'property' %} +:orphan: +{% endif %} + +{{ fullname | escape | underline}} + +.. currentmodule:: {{ module }} + +{% if objtype == 'property' %} +property +{% endif %} + +.. auto{{ objtype }}:: {{ objname }} + diff --git a/doc/source/conf.py b/doc/source/conf.py index 5ab02c4a4..83cecc917 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -4,7 +4,7 @@ from __future__ import division, absolute_import, print_function import sys, os, re # Minimum version, enforced by sphinx -needs_sphinx = '2.1.2' +needs_sphinx = '2.2.0' # ----------------------------------------------------------------------------- # General configuration |