#66: Docs improvements

riotkit-org · Aug 27, 2021 · 2db759b · 2db759b
1 parent cea6eb4
commit 2db759b
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/docs/source/pipelines.rst b/docs/source/pipelines.rst
@@ -225,3 +225,14 @@ Works similar as **@error**, but with difference that **@rescue** changes the re
 **Example workflow:**
 
 .. image:: rkd-pipeline-rescue.png
+
+
+Python syntax reference (API)
+-----------------------------
+
+.. autoclass:: rkd.core.api.syntax.Pipeline
+
+.. autoclass:: rkd.core.api.syntax.PipelineTask
+
+.. autoclass:: rkd.core.api.syntax.PipelineBlock
+
diff --git a/docs/source/rts/rts-1.rst b/docs/source/rts/rts-1.rst
@@ -135,7 +135,9 @@ There exists actually three available syntax styles.
 
 --------------
 
-1. Python Class: Classic syntax \*******************************\*
+1. Python Class: Classic syntax
+
+--------------
 
 Classic syntax has no limits, it’s main purpose is to define Base Tasks,
 that could be extended later **due to its native construct could be
@@ -172,7 +174,9 @@ packaged as PyPI/PIP package.**
 
 --------------
 
-2. Simplified Python syntax \**************************\*
+2. Simplified Python syntax
+
+--------------
 
 Allows writing Tasks that extends Base Tasks in a very easy and short
 manner.
@@ -209,7 +213,9 @@ manner.
 
 --------------
 
-3. Document/YAML syntax \**********************\*
+3. Document/YAML syntax
+
+--------------
 
 Has similar purpose as ``Simplified Python syntax``, but should be
 simpler for non-programmers like System Administrators, or just for