Files
Actions/doc/JobTemplate/StaticTypeCheck.rst
Patrick Lehmann c78c1c8503 Added Sphinx based documentation.
(cherry picked from commit f9f5dd5117a14ba31a3a9113a1de2c12c624dffb)
2022-10-29 22:42:09 +02:00

66 lines
834 B
ReStructuredText

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