Skip to content
This repository has been archived by the owner on Aug 10, 2024. It is now read-only.

Commit

Permalink
[tests] Add README.rst check
Browse files Browse the repository at this point in the history
Neither PyPi nor GitHub support the sphinx-specific directives,
obviously. So adding a check in tox to ensure the restructuredtext
is clean.
  • Loading branch information
Finistere committed Mar 19, 2022
1 parent 2694f6a commit 6856393
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Simple, right ? And you can still use it like a normal function, typically when
f(Database())
:py:func:`.inject` here used the marker :code:`inject.me()` with the help of the type hint to determine
:code:`.inject` here used the marker :code:`inject.me()` with the help of the type hint to determine
the dependency. But it also supports the following ways to express the dependency wiring:

- annotated type hints:
Expand Down
14 changes: 12 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
[tox]
; need no_attrs instead of nothing for tox-travis (see travis:env)
envlist = manifest,flake8,mypy,py{37,38,39,310}{,-compiled},coverage-report,docs
envlist = manifest,flake8,mypy,py{37,38,39,310}{,-compiled},coverage-report,docs,rstvalidator
isolated_build = true

[gh-actions]
python =
3.7: py37{,-compiled}
3.8: py38{,-compiled}
3.9: py39{,-compiled},flake8,manifest,docs,pyright
3.9: py39{,-compiled},flake8,manifest,docs,pyright,rstvalidator
3.10: py310{,-compiled}

[testenv]
Expand Down Expand Up @@ -69,6 +69,16 @@ max-line-length = 100
; max-complexity = 10


[testenv:rstvalidator]
changedir = {toxinidir}
skip_install = true
deps =
rstvalidator==2020.12.3
pygments==2.11.2
commands =
python -m rstvalidator README.rst


[testenv:docs]
changedir = docs
deps =
Expand Down

0 comments on commit 6856393

Please sign in to comment.