Merge pull request #84 from astrofrog/use-tox

Fix packaging bug, add tox configuration, and switched to Azure Pipelines

Author: bsipocz

.coveragerc

@@ -1,4 +1,12 @@
 [run]
 source = sphinx_automodapi
-omit = sphinx_automodapi/tests/*.py
+omit = */tests/*
 
+[paths]
+source =
+    sphinx_automodapi/
+    */site-packages/sphinx_automodapi
+    *\site-packages\sphinx_automodapi
+
+[report]
+omit = */tests/*

.travis.yml

@@ -1,70 +1,34 @@
-# We set the language to c because python isn't supported on the MacOS X nodes
-# on Travis. However, the language ends up being irrelevant anyway, since we
-# install Python ourselves using conda.
+# Most of the CI testing happens on Azure, but this configuration is for a
+# regular cron job on Travis (as well as for pull requests).
+
 language: c
 
 os:
-    - osx
     - linux
 
-# Adding notifications since this is a project we otherwise don't update
-# often, but need to make sure we see failures when they happen when
-# running cron jobs.
-notifications:
-  email:
-    recipients:
-      - [email protected]
-
 # Setting sudo to false opts in to Travis-CI container-based builds.
 sudo: false
 
-# The apt packages below are needed for sphinx builds, which can no longer
-# be installed with sudo apt-get.
 addons:
     apt:
         packages:
             - graphviz
 
 env:
-  matrix:
-    - PYTHON_VERSION=2.7
-    - PYTHON_VERSION=3.4 SPHINX_VERSION=1.3
-    - PYTHON_VERSION=3.5 SPHINX_VERSION=1.4
-    - PYTHON_VERSION=3.5 SPHINX_VERSION=1.5
-    - PYTHON_VERSION=3.6 SPHINX_VERSION=1.6
-    - PYTHON_VERSION=3.6 SPHINX_VERSION=1.7
-    - PYTHON_VERSION=3.7 SPHINX_VERSION=1.8
-    - PYTHON_VERSION=3.7 SPHINX_VERSION=2.0
-    - PYTHON_VERSION=3.7 SPHINX_VERSION=dev CONDA_DEPENDENCIES="setuptools cython pytest-cov"
-    - PYTHON_VERSION=2.7 LOCALE=C
-    - PYTHON_VERSION=3.7 LOCALE=C
   global:
-    - LOCALE=default
-    - CONDA_DEPENDENCIES="setuptools sphinx cython pytest-cov"
+    - CONDA_DEPENDENCIES="setuptools cython pytest-cov"
     - PIP_DEPENDENCIES="codecov"
     - HOMEBREW_NO_AUTO_UPDATE=1
+    - PYTHON_VERSION=3.7
+    - EVENT_TYPE=cron
 
 before_install:
-
-    # Make sure that things work even if the locale is set to C (which effectively means ASCII).
-    # Some of the input rst files have unicode characters and we need to deal with this gracefully.
-    - if [[ $LOCALE == C ]]; then
-        export LC_CTYPE=C;
-        export LC_ALL=C;
-        export LANG=C;
-      fi
-
     - if [[ $TRAVIS_OS_NAME == osx ]]; then brew install graphviz; fi
 
 install:
     - git clone git://github.com/astropy/ci-helpers.git
     - source ci-helpers/travis/setup_conda.sh
-    - if [[ $SPHINX_VERSION == dev ]]; then
-        pip install git+https://github.com/sphinx-doc/sphinx.git;
-      fi
+    - pip install git+https://github.com/sphinx-doc/sphinx.git
 
 script:
-    - py.test --cov sphinx_automodapi sphinx_automodapi -v
-
-after_success:
-    - codecov
+    - pytest sphinx_automodapi

README.rst

@@ -9,6 +9,17 @@ available as a standalone package since it can be used for any other
 package. The documentation can be found on
 `ReadTheDocs <http://sphinx-automodapi.readthedocs.io/en/latest/>`_.
 
+Running tests
+-------------
+
+To run the tests, you can either do::
+
+    pytest sphinx_automodapi
+
+or if you have `tox <https://tox.readthedocs.io/en/latest/>`_ installed::
+
+    tox -e test
+
 .. |Travis Status| image:: https://travis-ci.org/astropy/sphinx-automodapi.svg?branch=master
    :target: https://travis-ci.org/astropy/sphinx-automodapi
 .. |AppVeyor status| image:: https://ci.appveyor.com/api/projects/status/warwyfj06t1rkn5p/branch/master?svg=true

appveyor.yml

@@ -1 +1,24 @@
+schedules:
+- cron: "0 0 * * 1"
+  displayName: "weekly"
+  branches:
+    include:
+    - master
+  always: "true"
 
+jobs:
+
+- template: azure-template.yml
+  parameters:
+    name: Linux
+    os: linux
+
+- template: azure-template.yml
+  parameters:
+    name: MacOSX
+    os: macosx
+
+- template: azure-template.yml
+  parameters:
+    name: Windows
+    os: windows

azure-pipelines.yml

@@ -0,0 +1,58 @@
+jobs:
+- job: ${{ format(parameters.name) }}
+  pool:
+    ${{ if eq(parameters.os, 'macosx') }}:
+      vmImage: macOS 10.13
+    ${{ if eq(parameters.os, 'linux') }}:
+      vmImage: Ubuntu 16.04
+    ${{ if eq(parameters.os, 'windows') }}:
+      vmImage: vs2017-win2016
+
+  steps:
+
+  - ${{ if eq(parameters.os, 'macosx') }}:
+    - script: brew install graphviz
+      displayName: Installing graphviz
+  - ${{ if eq(parameters.os, 'linux') }}:
+    - script: sudo apt-get install -y graphviz
+      displayName: Installing graphviz
+  - ${{ if eq(parameters.os, 'windows') }}:
+    - script: choco install graphviz vcpython27 curl codecov --no-progress
+      displayName: Installing graphviz, vcpython27, curl, and codecov
+
+  - task: UsePythonVersion@0
+    inputs:
+      versionSpec: '2.7'
+      architecture: 'x64'
+
+  - task: UsePythonVersion@0
+    inputs:
+      versionSpec: '3.5'
+      architecture: 'x64'
+
+  - task: UsePythonVersion@0
+    inputs:
+      versionSpec: '3.6'
+      architecture: 'x64'
+
+  - task: UsePythonVersion@0
+    inputs:
+      versionSpec: '3.7'
+      architecture: 'x64'
+
+  - script: pip install tox coverage
+    displayName: Installing tox and coverage
+
+  - script: tox
+    displayName: Running tests with tox
+
+  - bash: coverage combine .tmp/*/.coverage
+    displayName: Combining coverage results
+  - bash: coverage report
+    displayName: Show coverage
+
+  # As described in https://github.com/codecov/codecov-bash/issues/189, the
+  # official bash script doesn't use the correct variable names for pull
+  # requests, so we use a fork of the bash script for now.
+  - bash: bash <(curl https://raw.githubusercontent.com/astrofrog/codecov-bash/fixed-azure/codecov) -t $(codecov.token)
+    displayName: Uploading results to codecov

azure-template.yml

@@ -19,8 +19,17 @@ classifiers =
 [options]
 zip_safe = False
 packages = find:
-install_requires = sphinx>=1.3
+install_requires =
+    sphinx>=1.3
+
+[options.extras_require]
+test =
+    pytest
+    pytest-cov
+    cython
+    codecov
+    coverage
 
 [options.package_data]
 sphinx_automodapi = templates/*/*.rst
-sphinx_automodapi.tests = cases/*/*.*, cases/*/*/*.*, cases/*/*/*/*.*
+sphinx_automodapi.tests = cases/*/*.*, cases/*/*/*.*, cases/*/*/*/*.*, cases/*/*/*/*/*.*

setup.cfg

@@ -208,10 +208,10 @@ def automodapi_replace(sourcestr, app, dotoctree=True, docname=None,
             toctreestr = ':toctree: '
             api_dir = os.path.join(app.srcdir, app.config.automodapi_toctreedirnm)
             if docname is None:
-                doc_path = '.'
+                doc_path = app.srcdir
             else:
-                doc_path = os.path.join(app.srcdir, docname)
-            toctreestr += os.path.relpath(api_dir, os.path.dirname(doc_path)).replace(os.sep, '/')
+                doc_path = os.path.dirname(os.path.join(app.srcdir, docname))
+            toctreestr += os.path.relpath(api_dir, doc_path).replace(os.sep, '/')
         else:
             toctreestr = ''
 

sphinx_automodapi/automodapi.py

@@ -133,18 +133,13 @@ def run(self):
         env = self.state.document.settings.env
         modname = self.arguments[0]
 
-        try:
-            self.warnings[:] = []
-        except AttributeError:
-            self.warnings = []
-
         nodelist = []
 
         try:
             localnames, fqns, objs = find_mod_objs(modname)
         except ImportError:
             self.warn("Couldn't import module " + modname)
-            return self.warnings
+            return []
 
         try:
             # set self.content to trick the autosummary internals.
@@ -200,12 +195,15 @@ def run(self):
             # super(Autosummary,self).run()
             nodelist.extend(Autosummary.run(self))
 
-            return self.warnings + nodelist
+            return nodelist
         finally:  # has_content = False for the Automodsumm
             self.content = []
 
     def get_items(self, names):
-        self.genopt['imported-members'] = True
+        try:
+            self.bridge.genopt['imported-members'] = True
+        except AttributeError:  # Sphinx < 4.0
+            self.genopt['imported-members'] = True
         return Autosummary.get_items(self, names)
 
 
@@ -223,9 +221,8 @@ def run(self):
 
             nms, objs = find_mod_objs(self.arguments[0], onlylocals=ols)[1:]
         except ImportError:
-            self.warnings = []
             self.warn("Couldn't import module " + self.arguments[0])
-            return self.warnings
+            return []
 
         # Check if some classes should be skipped
         skip = self.options.get('skip', [])

sphinx_automodapi/automodsumm.py

@@ -43,7 +43,7 @@ def write_conf(filename, conf):
 
 
 intersphinx_mapping = {
-    'python': ('http://docs.python.org/{0}/'.format(sys.version_info[0]), None)
+    'python': ('https://docs.python.org/{0}/'.format(sys.version_info[0]), None)
     }
 
 DEFAULT_CONF = {'source_suffix': '.rst',

sphinx_automodapi/tests/test_cases.py

@@ -0,0 +1,39 @@
+[tox]
+envlist =
+    py27-test
+    py37-test
+    py27-test-clocale
+    py37-test-clocale
+    py27-test-sphinx13
+    py35-test-sphinx14
+    py35-test-sphinx15
+    py36-test-sphinx16
+    py36-test-sphinx17
+    py37-test-sphinx18
+    py37-test-sphinx20
+    py37-test-sphinxdev
+requires = pip >= 18.0
+           setuptools >= 30.3.0
+
+[testenv]
+changedir = .tmp/{envname}
+deps =
+    sphinx13: sphinx==1.3.6
+    sphinx14: sphinx==1.4.9
+    sphinx15: sphinx==1.5.6
+    sphinx16: sphinx==1.6.7
+    sphinx17: sphinx==1.7.9
+    sphinx18: sphinx==1.8.5
+    sphinx20: sphinx==2.0.1
+    sphinx21: sphinx==2.1.2
+    sphinxdev: git+https://github.com/sphinx-doc/sphinx.git
+extras =
+    test: test
+commands =
+    test: pytest --pyargs sphinx_automodapi --cov-append --cov sphinx_automodapi --cov-report=
+setenv =
+    clocale: LC_CTYPE=C
+    clocale: LC_ALL=C
+    clocale: LANG=C
+platform =
+    clocale: linux|darwin