sphinx-autoapi/tox.ini

[tox]
envlist =
    py{27,34,35,36,37}-sphinx{16,17,18},py{35,36,37}-sphinx{20,21}
    formatting
    lint
    docs

[travis]
python =
    2.7: py27
    3.4: py34
    3.5: py35
    3.6: py36
    3.7: py37

[testenv]
setenv =
    LANG=C
deps = -r{toxinidir}/requirements.txt
    pytest
    mock
    sphinx16: Sphinx<1.7
    sphinx17: Sphinx<1.8
    sphinx18: Sphinx<1.9
    sphinx20: Sphinx<2.1
    sphinx21: Sphinx<2.2
commands =
    py.test {posargs}

[testenv:formatting]
basepython = python3
deps =
    black
commands =
    black --check autoapi tests

[testenv:lint]
deps =
    pylint<2.3  # PyCQA/prospector#321
    prospector
commands =
    prospector \
    --profile-path={toxinidir} \
    --profile=prospector \
    --die-on-tool-error {posargs}

[testenv:docs]
deps =
    Sphinx>=2.1,<2.2
    sphinx_rtd_theme
changedir = {toxinidir}/docs
commands =
    sphinx-build -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
Add basic tox configuration 2015-08-03 18:24:39 +00:00			`[tox]`
Start altering the pydocstyle AST parser for our needs This forks some of the pydocstyle AST parser into out mapper. Eventually, some of the other operations such as parsing arguments and performing full name lookup can be moved in as well. For now, this is not doing any extra assignment tracking/etc, several of these operations will just throw this information out. Refs #99 2017-04-07 18:46:57 +00:00			`envlist =`
Added support for Sphinx 2.1 2019-06-23 20:23:23 +00:00			`py{27,34,35,36,37}-sphinx{16,17,18},py{35,36,37}-sphinx{20,21}`
Added Black formatting 2019-01-27 05:20:45 +00:00			`formatting`
Fix tox config 2017-04-07 19:01:17 +00:00			`lint`
			`docs`
Add basic tox configuration 2015-08-03 18:24:39 +00:00
Upgrade testing Conflicts: tox.ini 2017-06-29 19:27:46 +00:00			`[travis]`
			`python =`
			`2.7: py27`
			`3.4: py34`
			`3.5: py35`
			`3.6: py36`
Added Python 3.7 testing Also made Sphinx 1.8 testing use stable version 2018-11-15 06:40:55 +00:00			`3.7: py37`
Upgrade testing Conflicts: tox.ini 2017-06-29 19:27:46 +00:00
Add basic tox configuration 2015-08-03 18:24:39 +00:00			`[testenv]`
			`setenv =`
			`LANG=C`
			`deps = -r{toxinidir}/requirements.txt`
Improvements to pydocstyle Python parsing * Moves relative path parsing away from the base mapper implementation * Change argument parsing from splitting first line of source with ',' to use AST traversal instead. This is not complete, but mostly PoC for now. Full traversal into argument type nodes will allow us to get nested dict() etc. We should open a ticket to track this work * Cleans up some of the templates to reduce duplicate titles * Adds a directive for nesting rST from constructs that might have headings. Remove the first heading in this case to address the case where a module has a docstring with a heading up front * Adds tests * Replaces example module with module that has more failing cases of parsing Closes #78 Fixes #80 Fixes #81 Fixes #82 Fixes #83 Fixes #84 Fixes #85 2016-11-02 23:29:28 +00:00			`pytest`
			`mock`
Fix for Sphinx 1.6 2017-08-28 21:01:14 +00:00			`sphinx16: Sphinx<1.7`
Added sphinx 1.7 testing 2018-02-17 06:05:36 +00:00			`sphinx17: Sphinx<1.8`
Added Python 3.7 testing Also made Sphinx 1.8 testing use stable version 2018-11-15 06:40:55 +00:00			`sphinx18: Sphinx<1.9`
Added Sphinx 2.0 support 2019-04-06 17:04:15 +00:00			`sphinx20: Sphinx<2.1`
Added support for Sphinx 2.1 2019-06-23 20:23:23 +00:00			`sphinx21: Sphinx<2.2`
Add basic tox configuration 2015-08-03 18:24:39 +00:00			`commands =`
Clean up tox file 2015-08-03 21:01:54 +00:00			`py.test {posargs}`
Add basic tox configuration 2015-08-03 18:24:39 +00:00
Added Black formatting 2019-01-27 05:20:45 +00:00			`[testenv:formatting]`
			`basepython = python3`
Revert basestring -> str in check for autoapi_dirs Not sure we need to be concerned about byte strings here either way. Fixes #74 2016-06-08 23:34:52 +00:00			`deps =`
Stopped pinning black version 2019-03-30 18:47:11 +00:00			`black`
Add basic tox configuration 2015-08-03 18:24:39 +00:00			`commands =`
Added Black formatting 2019-01-27 05:20:45 +00:00			`black --check autoapi tests`
Add basic tox configuration 2015-08-03 18:24:39 +00:00
			`[testenv:lint]`
			`deps =`
Fixed tox setup 2019-06-23 18:42:05 +00:00			`pylint<2.3 # PyCQA/prospector#321`
Add basic tox configuration 2015-08-03 18:24:39 +00:00			`prospector`
			`commands =`
			`prospector \`
			`--profile-path={toxinidir} \`
			`--profile=prospector \`
Upgrade testing Conflicts: tox.ini 2017-06-29 19:27:46 +00:00			`--die-on-tool-error {posargs}`
Added Black formatting 2019-01-27 05:20:45 +00:00
			`[testenv:docs]`
			`deps =`
Added support for Sphinx 2.1 2019-06-23 20:23:23 +00:00			`Sphinx>=2.1,<2.2`
Added Black formatting 2019-01-27 05:20:45 +00:00			`sphinx_rtd_theme`
			`changedir = {toxinidir}/docs`
			`commands =`
Documentation overhaul 2019-04-07 00:56:05 +00:00			`sphinx-build -b html -d {envtmpdir}/doctrees . {envtmpdir}/html`