Bug #16833
closed
[build] replace python-epydoc in our build environment
Description
It's Python 2 only, and appears unmaintained upstream (?).
Whatever we change to will need to be reflected on the machine that hosts doc.arvados.org.
When done, make sure to update
lib/install/deps.goso that
arvados-server install -type testkeeps doing the right thing.
Related issues
Updated by Ward Vandewege over 3 years ago
- Related to Idea #14532: [Epic] Port to Python 3 to for Python 2 sunset in December 2019 added
Updated by Peter Amstutz over 3 years ago
- Target version set to 2020-10-07 Sprint
- Project changed from Arvados Epics to Arvados
Updated by Ward Vandewege over 3 years ago
- Target version changed from 2020-10-07 Sprint to 2020-09-23 Sprint
- Assigned To set to Ward Vandewege
- Status changed from New to In Progress
Updated by Ward Vandewege over 3 years ago
Ready for review in 3e029ed0f5c3774ac8e860cdcebf0619d924793f on branch 16833-replace-epydoc
Updated by Ward Vandewege over 3 years ago
- Subject changed from replace python-epydoc in our build environment to [build] replace python-epydoc in our build environment
Updated by Nico César over 3 years ago
I notice this change:
- STDERR.puts `epydoc --html --parse-only -o sdk/python/arvados ../sdk/python/arvados/ 2>&1` + STDERR.puts `pdoc --html -o sdk/python ../sdk/python/arvados/ 2>&1`
is this because pdoc doesn't have a "--parse-only" option and or "--dry-run"? Seems that the original intended purpose is just to check if a run will go ok, and report back. Is my assumption correct?
otherwise the change LGTM
Updated by Ward Vandewege over 3 years ago
Nico César wrote:
I notice this change:
[...]
is this because pdoc doesn't have a "--parse-only" option and or "--dry-run"? Seems that the original intended purpose is just to check if a run will go ok, and report back. Is my assumption correct?
The pdoc/epydoc call is not a dry run; it's the actual doc generation. --parse-only on epydoc is apparently a way to make it not do introspection for the documentation information. pdoc3 doesn't have a --parse-only option, it always uses introspection. Downside: this means we need to have the arvados python sdk installed on the system where we run pdoc3...
otherwise the change LGTM
Cool, thanks.
Updated by Ward Vandewege over 3 years ago
- % Done changed from 0 to 100
- Status changed from In Progress to Resolved
Applied in changeset arvados|eaf4338060c06006b451f79b4dba0ece41f7fef9.
Updated by Brett Smith over 1 year ago
- Related to Feature #5214: [SDKs] Use sphinx to render for Python SDK docs added
Updated by Brett Smith over 1 year ago
- Related to Task #15065: [Spike] Evaluate alternatives for Python docs added
Updated by Brett Smith over 1 year ago
- Related to Idea #15015: replace epydoc added
Updated by Brett Smith over 1 year ago
- Related to Support #13418: Python SDK must have docstrings for all public interfaces added