OpenCyphal / pycyphal

Python implementation of the Cyphal protocol stack.
https://pycyphal.readthedocs.io/
MIT License
117 stars 105 forks source link

Improving clarity demo #287

Closed maksimdrachov closed 1 year ago

maksimdrachov commented 1 year ago

todo:

See also: maksimdrachov/opencyphal-tutorial

maksimdrachov commented 1 year ago

The last one is a useless change, but:

image

(Feel free to roll back)

maksimdrachov commented 1 year ago

This remaining issue in CI:

image

I've added sphinxcontrib.contentui in order to allow toggling the view of "Graph explanation" (see docs/pages/demo.rst). I think it's a bit clearer if the reader can toggle certain parts of the explanation that might be useful upon the first read, but migh otherwise be a bit too long to include in the default view of the page.

relevant issue in ulrobix/sphinxcontrib-contentui

Doesn't look like it's actively maintained anymore.

So I guess: remove this extension and replace by something similar. Any suggestions?

pavel-kirienko commented 1 year ago

@maksimdrachov nudge

maksimdrachov commented 1 year ago

Feel free to merge, or keep open (since I might want to change some other small stuff around as well)

pavel-kirienko commented 1 year ago

I might want to change some other small stuff around as well

That's fine, let's take these changes in as they come in separate PRs.