Actions
Story #18798
open
Turn code cookbook into liquid template & include files separately
Status:
New
Priority:
Normal
Assigned To:
-
Category:
SDKs
Target version:
-
Start date:
Due date:
% Done:
0%
Estimated time:
Story points:
-
Release:
Release relationship:
Auto
Description
- Define list of titles and filenames in the config.yml for the documentation generator
- code snippets are moved into _include
- Liquid template generates a table of contents and then embeds each code snippet
- Write some text at the top of the code cookbook introducing how to use it
- run a code formatter like "black" on the python files
- propose (but do not implement) a testing strategy
Related issues
Updated by Peter Amstutz about 2 years ago
- Related to Support #18263: Plan to document the Python SDK added
Updated by Peter Amstutz about 2 years ago
- Related to Story #18800: Update Python SDK documentation added
Updated by
Actions