Project

General

Profile

Actions

Idea #18798

open

Turn code cookbook into liquid template & include files separately

Added by Peter Amstutz over 2 years ago. Updated 8 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
SDKs
Target version:
Start date:
Due date:
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

Related to Arvados - Support #18263: Plan to document the Python SDKResolvedPeter AmstutzActions
Related to Arvados Epics - Idea #18800: Update Python SDK documentationIn ProgressActions
Actions

Also available in: Atom PDF