Project

General

Profile

Actions

Story #18798

open

Turn code cookbook into liquid template & include files separately

Added by Peter Amstutz 6 months ago. Updated 6 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
SDKs
Target version:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Story points:
-

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

Related to Arvados - Support #18263: Plan to document the Python SDKResolvedPeter Amstutz

Actions
Related to Arvados Epics - Story #18800: Update Python SDK documentationNew06/01/202208/31/2022

Actions
Actions #1

Updated by Peter Amstutz 6 months ago

  • Description updated (diff)
Actions #2

Updated by Peter Amstutz 6 months ago

  • Description updated (diff)
Actions #3

Updated by Peter Amstutz 6 months ago

Actions #4

Updated by Peter Amstutz 6 months ago

  • Related to Story #18800: Update Python SDK documentation added
Actions

Also available in: Atom PDF