Revamp documentation #39

New issue

Open

opened 2026-08-27 09:24:15 +02:00 by ni · 0 comments

ni commented

2026-08-27 09:24:15 +02:00

Owner

A large part of the documentation can — and should — be generated from the function docstrings.

AFAIK tools exist to do that; maybe one of them is suited to the task. If not, it should be easy to build one: import library, traverse its __dict__, get the documentation of each function and variable, build stuff.

Also, an overview that describes the ideas, with links into the detailed function/variable documentation.

A large part of the documentation can — and should — be generated from the function docstrings. AFAIK tools exist to do that; maybe one of them is suited to the task. If not, it should be easy to build one: import library, traverse its `__dict__`, get the documentation of each function and variable, build stuff. Also, an overview that describes the ideas, with links into the detailed function/variable documentation.

ni self-assigned this

2026-08-27 09:24:15 +02:00

ni added the

normal

research

labels

2026-08-27 09:24:47 +02:00