Project

General

Profile

Actions

Story #20853

closed

Switch from pdoc3 to pdoc

Added by Brett Smith 7 months ago. Updated 6 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Target version:
Start date:
08/15/2023
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
Story points:
0.5
Release relationship:
Auto

Description

pdoc3 is a semi-hostile fork of pdoc, it seems to be less maintained (last release in 2021 vs. June this year for pdoc), and the maintainer thinks it's cute to put a swastika on their web site to make people “question their assumptions.” They still use a very swastika-like image as their GitHub profile picture too.

Switching to original pdoc is fairly easy:

  • Remove the --html command line switch from doc/Rakefile.
  • doc/sdk/python/python.html.textile.liquid needs to update its iframe src to be arvados.html (the file, not the subdirectory).
  • Update the pip install command in build/run-tests.sh and doc/README.textile.

There are output differences that we'll need to go over but it's at least as complete as the output we currently get.


Subtasks 1 (0 open1 closed)

Task #20856: Review 20853-pdocResolvedPeter Amstutz08/15/2023

Actions

Related issues

Precedes Arvados - Story #20885: Revise Python docstring style for Markdown extensionsResolvedBrett Smith08/16/2023

Actions
Actions

Also available in: Atom PDF