Project

General

Profile

Actions
Copy link

Idea #18798

open

Turn code cookbook into liquid template & include files separately

Added by Peter Amstutz almost 3 years ago. Updated 10 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
SDKs
Target version:
Future
Start date:
Due date:
Story points:
-
Release:
Postponed
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 2 (1 open — 1 closed)

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

Updated by Peter Amstutz almost 3 years ago

  • Description updated (diff)
Actions
Copy link
 #2

Updated by Peter Amstutz almost 3 years ago

  • Description updated (diff)
Actions
Copy link
 #3

Updated by Peter Amstutz almost 3 years ago

Actions
Copy link
 #4

Updated by Peter Amstutz almost 3 years ago

  • Related to Idea #18800: Update Python SDK documentation added
Actions
Copy link
 #5

Updated by Peter Amstutz almost 2 years ago

  • Release set to 60
Actions
Copy link
 #6

Updated by Peter Amstutz 10 months ago

  • Target version set to Future
Actions
Copy link

Also available in: Atom PDF