view pdoc output

[bertsky]

Although it would be possible to dive into the docstrings on the Python interpreter, I would very much like to view the generated API documentation (HTML output).

Now, the Readme just references the Jupyter notebook – which is great BTW, but often crashes, and does not provide a top-down overview of the API.

There seems to be a configuration already under pdoc/make.sh, which IIUC uses pdoc3 (not pdoc). But I cannot get it to run under Python 3.8 (despite installing pdoc3 plus everything I can find under environment.yml):

Traceback (most recent call last):
  File "/pdoc/__init__.py", line 222, in import_module
    module = importlib.import_module(module_path)
  File "/usr/lib/python3.8/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1014, in _gcd_import
  File "<frozen importlib._bootstrap>", line 991, in _find_and_load
  File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 671, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 783, in exec_module
  File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
  File "/pyalign/__init__.py", line 13, in <module>
    from .solve import *
  File "/pyalign/solve.py", line 342, in <module>
    class MatrixForm:
  File "/pyalign/solve.py", line 343, in MatrixForm
    _solvers = solver_variants("solve")
  File "/pyalign/solve.py", line 323, in solver_variants
    (algorithm.Detail.SCORE, algorithm.Count.ONE, None, "optimal"): (
AttributeError: 'NoneType' object has no attribute 'Detail'

So I guess the issue for me is both,

• how do I get the pdoc generator running, and
• would you consider hosting this via CI / GH pages?