Project

General

Profile

Actions

Support #18799

closed

Strategy to generate Python SDK docstrings based on API docs

Added by Peter Amstutz about 2 years ago. Updated 7 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
SDKs
Due date:
Story points:
1.0
Release relationship:
Auto

Description

write script that

  • takes the discovery document
  • produces Python stubs with docstrings, type annotations etc corresponding to the google api client
  • adds the stub files to the python SDK
  • runs pydoc

The goal is for the methods/objects found under arvados.api() (generated on the fly by google api client) to be browsable in pydoc.


Files

GroupsIndexDoc.png (124 KB) GroupsIndexDoc.png Brett Smith, 01/16/2023 08:39 PM
GroupsIndexReturns.png (213 KB) GroupsIndexReturns.png Brett Smith, 01/16/2023 08:39 PM
discovery-pydoc-prototype.py (1.71 KB) discovery-pydoc-prototype.py Brett Smith, 01/16/2023 08:39 PM

Subtasks 1 (0 open1 closed)

Task #19724: Review 18799-api-pydocResolvedBrett Smith04/14/2023Actions

Related issues

Related to Arvados - Support #18263: Plan to document the Python SDKResolvedPeter AmstutzActions
Related to Arvados Epics - Idea #18800: Update Python SDK documentationIn Progress11/01/202203/31/2024Actions
Related to Arvados - Feature #19929: Improve documentation in the discovery documentNewBrett SmithActions
Actions

Also available in: Atom PDF