Support #18263

Plan to document the Python SDK

Added by Peter Amstutz 9 days ago. Updated about 9 hours ago.

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

0%

Estimated time:
(Total: 0.00 h)
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

Subtasks

Task #18269: ReviewNew

History

#1 Updated by Peter Amstutz 8 days ago

  • Assigned To set to Peter Amstutz

#2 Updated by Peter Amstutz about 9 hours ago

  • Description updated (diff)

Also available in: Atom PDF