mirror of
https://github.com/pyTooling/Actions.git
synced 2026-02-12 11:06:56 +08:00
43 lines
572 B
ReStructuredText
43 lines
572 B
ReStructuredText
.. _JOBTMPL/VerifyDocs:
|
|
|
|
VerifyDocs
|
|
##########
|
|
|
|
This job extracts code examples from the README and tests these code snippets.
|
|
|
|
**Behavior:**
|
|
|
|
TBD
|
|
|
|
**Dependencies:**
|
|
|
|
TBD
|
|
|
|
Instantiation
|
|
*************
|
|
|
|
Simple Example
|
|
==============
|
|
|
|
.. todo:: VerifyDocs:SimpleExample Needs documentation.
|
|
|
|
Complex Example
|
|
===============
|
|
|
|
.. todo:: VerifyDocs:ComplexExample Needs documentation.
|
|
|
|
Parameters
|
|
**********
|
|
|
|
.. todo:: VerifyDocs:Parameters Needs documentation.
|
|
|
|
Secrets
|
|
*******
|
|
|
|
This job template needs no secrets.
|
|
|
|
Results
|
|
*******
|
|
|
|
This job template has no output parameters.
|