Skip to content

Commit

Permalink
Doc: add build to tox & QA tests, remove type hints (more readable)
Browse files Browse the repository at this point in the history
  • Loading branch information
sbraz committed Nov 13, 2020
1 parent 60ed46d commit 733b4d1
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ addons:
jobs:
include:
- python: &python_main_version 3.8
env: TOXENV=black,flake8,isort,mypy,pylint
env: TOXENV=docs,black,flake8,isort,mypy,pylint
- python: 3.6
env: TOXENV=py36
- python: 3.7
Expand Down
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.PHONY: all
all:
tox -p

.PHONY: qa
qa:
tox -p -e "black,flake8,isort,mypy,pylint"
tox -p -e "docs,black,flake8,isort,mypy,pylint"
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@
# ones.
extensions = [ 'sphinx.ext.autodoc' ]

# Type hints aren't very readable in the doc at the moment
autodoc_typehints = "none"

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

Expand Down
6 changes: 6 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ deps =
commands =
pytest {posargs}

[testenv:docs]
deps = sphinx
commands = sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out" --color -W {posargs}

[testenv:black]
deps =
black
Expand All @@ -32,6 +36,8 @@ deps = isort
commands = isort --check pymediainfo tests

[testenv:pylint]
# TODO: remove constraint when this is fixed: https://github.com/PyCQA/pylint/issues/3882
basepython = python3.8
deps =
pylint
pytest
Expand Down

0 comments on commit 733b4d1

Please sign in to comment.