Project

General

Profile

Actions

Support #18263

closed

Plan to document the Python SDK

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

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Target version:
Start date:
Due date:
% Done:

0%

Estimated time:
Story points:
-

Description

Goal: Provide complete documentation of the Arvados Python SDK, in a format that's easy and familiar.

  1. Use standard documentation generation system & templates.
    1. Sphinx?
    2. What does ReadTheDocs do?
  2. Need to generate documentation for the dynamic methods that are produced by the Google discovery doc
  3. Need to go over existing docstrings & format them properly
  4. Need to add new docstrings
  5. Incorporate the cookbook

12/15

  • expanding code cookbook
  • tutorial using arvados and python SDK at once
    • using collections and stuff
  • submitting containers (maybe improve programmatic arvados_cwl interface)
  • "orientation to how this works"
  • fixing the reference doc
  • how can we describe our current API spec as OpenAPI
  • use language-neutral API with language-specific snippets
  • explain how to use neutral API docs with Python
  • spend some time just seeing if we can make pydoc look better by adding some more doc strings
  • stories
    • outline of what the tutorial should be
    • spike investigate pydoc

Related issues

Related to Arvados - Story #18797: Flesh out python sdk documentation in docstrings & ensure good presentation in pydocIn Progress

Actions
Related to Arvados - Story #18799: Strategy to tie the Python SDK to the API docsNew

Actions
Related to Arvados - Story #18798: Turn code cookbook into liquid template & include files separatelyNew

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

Actions
Actions #1

Updated by Peter Amstutz 10 months ago

  • Assigned To set to Peter Amstutz
Actions #2

Updated by Peter Amstutz 10 months ago

  • Description updated (diff)
Actions #3

Updated by Peter Amstutz 10 months ago

  • Target version changed from 2021-10-27 sprint to 2021-11-10 sprint
Actions #4

Updated by Peter Amstutz 9 months ago

  • Target version changed from 2021-11-10 sprint to 2021-11-24 sprint
Actions #5

Updated by Peter Amstutz 9 months ago

  • Target version changed from 2021-11-24 sprint to 2021-12-08 sprint
Actions #7

Updated by Peter Amstutz 8 months ago

  • Target version changed from 2021-12-08 sprint to 2022-01-05 sprint
Actions #8

Updated by Peter Amstutz 8 months ago

  • Description updated (diff)
Actions #9

Updated by Peter Amstutz 8 months ago

  • Target version changed from 2022-01-05 sprint to 2022-01-19 sprint
Actions #10

Updated by Peter Amstutz 7 months ago

  • Target version changed from 2022-01-19 sprint to 2022-02-02 sprint
Actions #11

Updated by Peter Amstutz 7 months ago

  • Target version changed from 2022-02-02 sprint to 2022-02-16 sprint
Actions #12

Updated by Peter Amstutz 6 months ago

  • Target version changed from 2022-02-16 sprint to 2022-03-02 sprint
Actions #13

Updated by Peter Amstutz 6 months ago

  • Status changed from New to In Progress
Actions #14

Updated by Peter Amstutz 6 months ago

  • Related to Story #18797: Flesh out python sdk documentation in docstrings & ensure good presentation in pydoc added
Actions #15

Updated by Peter Amstutz 6 months ago

  • Related to Story #18799: Strategy to tie the Python SDK to the API docs added
Actions #16

Updated by Peter Amstutz 6 months ago

  • Related to Story #18798: Turn code cookbook into liquid template & include files separately added
Actions #17

Updated by Peter Amstutz 6 months ago

  • Status changed from In Progress to Resolved
Actions #18

Updated by Peter Amstutz 6 months ago

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

Also available in: Atom PDF