Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update shared-bindings/index.rst #1970

Closed
dhalbert opened this issue Jun 25, 2019 · 6 comments
Closed

Update shared-bindings/index.rst #1970

dhalbert opened this issue Jun 25, 2019 · 6 comments
Milestone

Comments

@dhalbert
Copy link
Collaborator

The list of supported modules per port is out of date in a number of ways.

It would be nice to have this generated automatically, but that might not be easy.

@dhalbert dhalbert added this to the Long term milestone Jun 25, 2019
@sommersoft
Copy link
Collaborator

sommersoft commented Jun 25, 2019

It would be nice to have this generated automatically, but that might not be easy.

An "immediate and unverified" thought would be to have a python script that scans the base definitions (circuitpy_mpconfig.mk, shared-bindings, etc), then cycles through each board's mpconfig.mk matching against the base. Output is compiled into a JSON file. Then, on the Sphinx side, have a Jinja template that builds the .rst page using the JSON data.

Quick related searches:

@sommersoft
Copy link
Collaborator

While this is "initially" done, there is a slight problem. Which actually isn't new to us.

The generated table does not wrap the text: https://circuitpython.readthedocs.io/en/latest/shared-bindings/support_matrix.html#support-matrix

After some searching, this is primarily a sphinx-rtd-theme issue.

There exists a workaround, which is already implemented in docs/static/customstyle.css. However, it doesn't seem to work for this particular table. That may be related to how the rstjinja extension is pushing the output to the html builder.

Do we want to leave this issue open, or create a new one?

@tannewt
Copy link
Member

tannewt commented Jul 30, 2019

I think this is ok to close. It's probably best to have separate pages for each board which explain what is present and what is missing.

@sommersoft
Copy link
Collaborator

Closing, then. I'll make a new (or two) issue with some outlying issues, and include the "future page-per-board".

@dhalbert
Copy link
Collaborator Author

For your new issues: table looks nice informationally but doesn't wrap;

image

@sommersoft
Copy link
Collaborator

sommersoft commented Aug 13, 2019

Yep. I haven't been actively working it, but I opened #2021 to track it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants