mirror of
https://github.com/pyTooling/Actions.git
synced 2026-02-17 13:36:56 +08:00
Added Sphinx based documentation.
(cherry picked from commit f9f5dd5117a14ba31a3a9113a1de2c12c624dffb)
This commit is contained in:
65
doc/JobTemplate/StaticTypeCheck.rst
Normal file
65
doc/JobTemplate/StaticTypeCheck.rst
Normal file
@@ -0,0 +1,65 @@
|
||||
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*
|
||||
Reference in New Issue
Block a user