Documentation improvements.

This commit is contained in:
Patrick Lehmann
2022-10-29 23:32:32 +02:00
parent ebdc386c6e
commit 1ab3b1a1e9
5 changed files with 60 additions and 27 deletions

View File

@@ -1,31 +1,33 @@
StaticTypeCheck
###############
collect static type check result with `mypy`, and
optionally upload results as an HTML report.
Example `commands`:
collect static type check result with mypy, and optionally upload results as an HTML report.
1. Regular package
Example ``commands``:
1. Regular package
.. code-block:: yaml
```yml
commands: mypy --html-report htmlmypy -p ToolName
```
2. Parent namespace package
```yml
2. Parent namespace package
.. code-block:: yaml
commands: |
touch Parent/__init__.py
mypy --html-report htmlmypy -p ToolName
```
3. Child namespace package
3. Child namespace package
.. code-block:: yaml
```yml
commands: |
cd Parent
mypy --html-report ../htmlmypy -p ToolName
```
Instantiation
*************