sphinx-autoapi/tox.ini

[tox]
isolated_build = true
envlist =
    # Keep this in sync with .github/workflows/main.yml
    py{37,38,39,310}
    formatting
    lint
    docs

[testenv]
extras =
    dotnet
    go
deps =
    pytest
commands =
    pytest {posargs}

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

[testenv:lint]
skip_install = true
deps =
    pylint~=2.4.2
commands =
    pylint {posargs:autoapi}

[testenv:docs]
extras =
    docs
changedir = {toxinidir}/docs
commands =
    sphinx-build -b html -d {envtmpdir}/doctrees . {envtmpdir}/html

[testenv:release]
skip_install = true
deps =
    build
    twine
commands =
    python -c "import shutil, os; os.path.isdir('dist') and shutil.rmtree('dist')"
    python -m build
    twine upload dist/*
Add basic tox configuration 2015-08-03 18:24:39 +00:00			`[tox]`
Package with PEP-517 2021-04-04 01:39:08 +00:00			`isolated_build = true`
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 =`
Start testing in Github Actions 2021-04-05 01:50:39 +00:00			`# Keep this in sync with .github/workflows/main.yml`
Drop Python 3.6 and test in Python 3.10 2021-12-23 09:15:07 +00:00			`py{37,38,39,310}`
Added Black formatting 2019-01-27 05:20:45 +00:00			`formatting`
Fix linting 2019-10-05 22:11:23 +00:00			`lint`
Fix tox config 2017-04-07 19:01:17 +00:00			`docs`
Add basic tox configuration 2015-08-03 18:24:39 +00:00
			`[testenv]`
Added documentation for optional dependencies 2019-09-08 00:25:03 +00:00			`extras =`
			`dotnet`
			`go`
Can run with tox 4 2021-04-03 02:20:16 +00:00			`deps =`
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`
Add basic tox configuration 2015-08-03 18:24:39 +00:00			`commands =`
Dropped support for Python 2 and Sphinx 1.x/2.x. Removed all old compatibility code. 2020-10-03 19:21:25 +00:00			`pytest {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`
Added documentation for optional dependencies 2019-09-08 00:25:03 +00:00			`skip_install = true`
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 =`
Show black diff 2020-05-15 11:11:58 +00:00			`black --check --diff autoapi tests`
Add basic tox configuration 2015-08-03 18:24:39 +00:00
			`[testenv:lint]`
Added documentation for optional dependencies 2019-09-08 00:25:03 +00:00			`skip_install = true`
Add basic tox configuration 2015-08-03 18:24:39 +00:00			`deps =`
Fix linting 2019-10-05 22:11:23 +00:00			`pylint~=2.4.2`
Add basic tox configuration 2015-08-03 18:24:39 +00:00			`commands =`
Fix linting 2019-10-05 22:11:23 +00:00			`pylint {posargs:autoapi}`
Added Black formatting 2019-01-27 05:20:45 +00:00
			`[testenv:docs]`
Readthedocs uses Python 3.8 2020-10-08 05:24:46 +00:00			`extras =`
			`docs`
Added Black formatting 2019-01-27 05:20:45 +00:00			`changedir = {toxinidir}/docs`
			`commands =`
Documentation overhaul 2019-04-07 00:56:05 +00:00			`sphinx-build -b html -d {envtmpdir}/doctrees . {envtmpdir}/html`
Streamlined release process slightly 2022-07-25 19:00:54 +00:00
			`[testenv:release]`
			`skip_install = true`
			`deps =`
			`build`
			`twine`
			`commands =`
			`python -c "import shutil, os; os.path.isdir('dist') and shutil.rmtree('dist')"`
			`python -m build`
			`twine upload dist/*`