Actions
Support #18263
closedPlan to document the Python SDK
Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Target version:
Due date:
Story points:
-
Description
Goal: Provide complete documentation of the Arvados Python SDK, in a format that's easy and familiar.
- Use standard documentation generation system & templates.
- Sphinx?
- What does ReadTheDocs do?
- Need to generate documentation for the dynamic methods that are produced by the Google discovery doc
- Need to go over existing docstrings & format them properly
- Need to add new docstrings
- 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
Updated by Peter Amstutz about 3 years ago
- Target version changed from 2021-10-27 sprint to 2021-11-10 sprint
Updated by Peter Amstutz almost 3 years ago
- Target version changed from 2021-11-10 sprint to 2021-11-24 sprint
Updated by Peter Amstutz almost 3 years ago
- Target version changed from 2021-11-24 sprint to 2021-12-08 sprint
Updated by Peter Amstutz almost 3 years ago
- Target version changed from 2021-12-08 sprint to 2022-01-05 sprint
Updated by Peter Amstutz almost 3 years ago
- Target version changed from 2022-01-05 sprint to 2022-01-19 sprint
Updated by Peter Amstutz almost 3 years ago
- Target version changed from 2022-01-19 sprint to 2022-02-02 sprint
Updated by Peter Amstutz almost 3 years ago
- Target version changed from 2022-02-02 sprint to 2022-02-16 sprint
Updated by Peter Amstutz over 2 years ago
- Target version changed from 2022-02-16 sprint to 2022-03-02 sprint
Updated by Peter Amstutz over 2 years ago
- Status changed from New to In Progress
Updated by Peter Amstutz over 2 years ago
- Related to Idea #18797: Flesh out python sdk documentation in docstrings & ensure good presentation in pydoc added
Updated by Peter Amstutz over 2 years ago
- Related to Support #18799: Strategy to generate Python SDK docstrings based on API docs added
Updated by Peter Amstutz over 2 years ago
- Related to Idea #18798: Turn code cookbook into liquid template & include files separately added
Updated by Peter Amstutz over 2 years ago
- Status changed from In Progress to Resolved
Updated by Peter Amstutz over 2 years ago
- Related to Idea #18800: Update Python SDK documentation added
Actions