ahriman/tox.ini
Evgenii Alekseev 2dac5a2520 Docs update (#61)
* Improve sphinx documentation

* update faq formatting

* fix setup doc

* fix docs according to the generated htmls
2022-05-06 02:54:37 +03:00

55 lines
1.5 KiB
INI

[tox]
envlist = check, tests
dependencies = -e .[pacman,s3,web]
project_name = ahriman
[pytest]
addopts = --cov=ahriman --cov-report=term-missing:skip-covered --no-cov-on-fail --cov-fail-under=100 --spec
asyncio_mode = auto
spec_test_format = {result} {docstring_summary}
[testenv]
deps =
{[tox]dependencies}
[testenv:check]
deps =
{[tox]dependencies}
-e .[check]
allowlist_externals =
/bin/bash
setenv =
MYPYPATH=src
commands =
autopep8 --exit-code --max-line-length 120 -aa -i -j 0 -r "src/{[tox]project_name}" "tests/{[tox]project_name}"
pylint --rcfile=.pylintrc "src/{[tox]project_name}"
bandit -c .bandit.yml -r "src/{[tox]project_name}"
bandit -c .bandit-test.yml -r "tests/{[tox]project_name}"
/bin/bash -c 'mypy --implicit-reexport --strict -p "{[tox]project_name}" --install-types --non-interactive || mypy --implicit-reexport --strict -p "{[tox]project_name}"'
[testenv:docs]
deps =
{[tox]dependencies}
-e .[docs]
changedir = src
setenv =
SPHINX_APIDOC_OPTIONS=members,no-undoc-members,show-inheritance
commands =
argparse-manpage --module ahriman.application.ahriman --function _parser --author "ahriman team" --project-name ahriman --author-email "" --url https://github.com/arcan1s/ahriman --output ../docs/ahriman.1
pydeps ahriman -o ../docs/ahriman-architecture.svg --no-config --no-show --cluster
sphinx-apidoc -o ../docs .
[testenv:docs-html]
deps =
{[tox]dependencies}
-e .[docs]
commands =
sphinx-build -b html -a -j auto docs docs/html
[testenv:tests]
deps =
{[tox]dependencies}
-e .[tests]
commands =
pytest {posargs}