Bug #16833: [build] replace python-epydoc in our build environment - Arvados

Custom queries

All assigned issues
All issues assigned for grooming
My issues for grooming
My issues for grooming (no story pts)
Prioritized open issues

Actions

Copy link

Bug #16833

closed

[build] replace python-epydoc in our build environment

Added by Ward Vandewege over 4 years ago. Updated about 4 years ago.

Status:

Resolved

Priority:

Normal

Assigned To:

Ward Vandewege

Category:

Target version:

2020-09-23 Sprint

Story points:

Release:

Arvados 2.1.0

Release relationship:

Auto

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.go

so that

arvados-server install -type test

keeps doing the right thing.

Subtasks 1 (0 open — 1 closed)

Task #16840: review 16833-replace-epydoc

Resolved

Nico César

09/16/2020

Actions

Related issues 5 (1 open — 4 closed)

Related to Arvados Epics - Idea #14532: [Epic] Port to Python 3 to for Python 2 sunset in December 2019	Resolved	01/01/2020	09/16/2020	Actions
Related to Arvados - Feature #5214: [SDKs] Use sphinx to render for Python SDK docs	Rejected			Actions
Related to Arvados - Task #15065: [Spike] Evaluate alternatives for Python docs	Closed	01/11/2023		Actions
Related to Arvados - Idea #15015: replace epydoc	Duplicate	01/11/2023		Actions
Related to Arvados - Support #13418: Python SDK must have docstrings for all public interfaces	New			Actions

Issue # Delay: days Cancel

History
Notes
Property changes
Associated revisions

Actions

Copy link

Updated by Ward Vandewege over 4 years ago

Related to Idea #14532: [Epic] Port to Python 3 to for Python 2 sunset in December 2019 added

Actions

Copy link

Updated by Peter Amstutz over 4 years ago

Target version set to 2020-10-07 Sprint
Project changed from Arvados Epics to Arvados

Actions

Copy link

Updated by Ward Vandewege over 4 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

Actions

Copy link

Updated by Ward Vandewege over 4 years ago

Ready for review in 3e029ed0f5c3774ac8e860cdcebf0619d924793f on branch 16833-replace-epydoc

Actions

Copy link

Updated by Ward Vandewege over 4 years ago

Subject changed from replace python-epydoc in our build environment to [build] replace python-epydoc in our build environment

Actions

Copy link

Updated by Nico César over 4 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

Actions

Copy link

Updated by Ward Vandewege over 4 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...