autobahn-python icon indicating copy to clipboard operation
autobahn-python copied to clipboard

XBR API docs: some imports fail on RTD

Open gdmoore opened this issue 4 years ago • 4 comments

https://autobahn.readthedocs.io/en/latest/reference/autobahn.html

It looks like sphinx-autodoc didn't run properly; only util has any documentation, all other sections are blank.

gdmoore avatar Mar 18 '20 13:03 gdmoore

Is there any plan to restore this reference documentation since its lack still persists? For us it would be very important.

blinkingmatt avatar Sep 30 '20 10:09 blinkingmatt

well, the fix might be https://github.com/crossbario/autobahn-python/commit/3ea4fdae9814641f6dcc03a2deb4e555b2f9a776 ... lets see ... I had to merge it right to master to make RTD trigger ..

oberstet avatar Sep 30 '20 12:09 oberstet

ok, right, that worked: https://autobahn.readthedocs.io/en/latest/reference/autobahn.websocket.html

Bildschirmfoto von 2020-09-30 14-55-17

there are some smallish xbr related api docs complaining .. see end of https://readthedocs.org/api/v2/build/11994732.txt - renaming this issue to reflect that (I don't have time to look into that now .. should be trivial to fix)

oberstet avatar Sep 30 '20 12:09 oberstet

Great. Thanks.

blinkingmatt avatar Sep 30 '20 13:09 blinkingmatt