Bug #16833

[build] replace python-epydoc in our build environment

Added by Ward Vandewege about 1 year ago. Updated about 1 year ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
-
Target version:
Start date:
09/16/2020
Due date:
% Done:

100%

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

Task #16840: review 16833-replace-epydocResolvedNico César


Related issues

Related to Arvados Epics - Story #14532: [Epic] Port to Python 3 to for Python 2 sunset in December 2019Resolved01/01/202009/16/2020

Associated revisions

Revision eaf43380
Added by Ward Vandewege about 1 year ago

Merge branch '16833-replace-epydoc' into master

closes #16833

Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <>

History

#1 Updated by Ward Vandewege about 1 year ago

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

#2 Updated by Peter Amstutz about 1 year ago

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

#3 Updated by Ward Vandewege about 1 year 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

#4 Updated by Ward Vandewege about 1 year ago

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

#5 Updated by Ward Vandewege about 1 year ago

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

#6 Updated by Nico César about 1 year 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

#7 Updated by Ward Vandewege about 1 year 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.

#8 Updated by Ward Vandewege about 1 year ago

  • % Done changed from 0 to 100
  • Status changed from In Progress to Resolved

#9 Updated by Peter Amstutz about 1 year ago

  • Release set to 25

Also available in: Atom PDF