Skip to content

Docs: Module Support Matrix Updates #2021

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

Closed
1 of 3 tasks
sommersoft opened this issue Jul 31, 2019 · 5 comments
Closed
1 of 3 tasks

Docs: Module Support Matrix Updates #2021

sommersoft opened this issue Jul 31, 2019 · 5 comments
Labels
documentation good first issue Hacktoberfest Beginner friendly issues for Hacktoberfest event
Milestone

Comments

@sommersoft
Copy link

sommersoft commented Jul 31, 2019

Now that the first iteration of the new module support matrix is done, it needs more work. I'm going to put a few issues into this single one; if anyone would rather have them broken up feel free (or let me know).

  • Text does not wrap in the matrix table:
    There are some CSS settings that are in /docs/static/customstyle.css that should force wrapping inside the table. They are somehow either getting overwritten, or not included.

  • Some modules are not captured correctly by /docs/shared_bindings_matrix.py:
    These can be handled as special cases, or there may be some way to correlate them by just deepening the map. But, I definitely don't subscribe to the notion that the core should bend to the docs.

    • wiznet: this module has not been migrated to the "newer" definition system, and relies on
      #ifdefs. As such, it will not show up in the support matrix as is.

    • fontio/terminalio: these two are included based on CIRCUITPY_DISPLAYIO, and do not have their own entries in circuitpy_mpconfig.mk. The documentation does not currently provide any indication that displayio is required.

    • socket: this is included based on CIRCUITPY_NETWORK, and does not have it's own entry. Documentation also does not state that network is required.

    • audiocore: this is included based on CIRCUITPY_AUDIOIO, but has its own entry in cirpy_mpconfig.mk. As such, it will show up available on all boards because there is nothing to negate it.


  • Have a separate page for each board:
    • Initial thought is to add a /docs/boards directory where the pages will live.
    • Would love to have them completely built dynamically. May be possible with Jinja and Sphinx templating (I'm not smart enough on templating yet).
    • @tannewt mentioned having each page list "what is present, and what is not".
@Neradoc
Copy link

Neradoc commented Mar 29, 2021

I'd add to the list of modules that are not captured: adafruit_bus_device, recently added to the core, also missing from the matrix, since it's based on CIRCUITPY_BUSDEVICE.

Also, the aliased boards are missing from the Support Matrix. These are boards where the build is identical to another, and therefore is not generated on its own, but only listed separately on circuitpython.org and copied to S3. As seen in build_board_info.py:
https://github.com/adafruit/circuitpython/blob/main/tools/build_board_info.py#L76-L85

As a tangent, I would suggest migrating from lists in python scripts to a separate configuration file (or files) for the list of aliases, language_allow_list, SUPPORTED_PORTS and such.

microdev1 pushed a commit that referenced this issue Jul 23, 2021
The newer modules are `socketpool` and `ssl`.

Fixes #3924, related to #2021, closes #1880, closes #2273, closes #2274
@adafruit-adabot adafruit-adabot added the Hacktoberfest Beginner friendly issues for Hacktoberfest event label Oct 26, 2021
@FoamyGuy FoamyGuy removed the Hacktoberfest Beginner friendly issues for Hacktoberfest event label Nov 8, 2021
@adafruit-adabot adafruit-adabot added the Hacktoberfest Beginner friendly issues for Hacktoberfest event label Sep 29, 2022
@skerr92
Copy link

skerr92 commented Oct 16, 2022

Given this issue has had a few PRs merged on it (see above), is it safe to have this one closed?

@dhalbert
Copy link
Collaborator

Given this issue has had a few PRs merged on it (see above), is it safe to have this one closed?

Could you check on the missing modules mentioned in the second task? If they are present then we could close, otherwise need to add them too.

@skerr92
Copy link

skerr92 commented Oct 16, 2022

Given this issue has had a few PRs merged on it (see above), is it safe to have this one closed?

Could you check on the missing modules mentioned in the second task? If they are present then we could close, otherwise need to add them too.

It appears only fontio/terminalio has been captured in the shared_bindings_matrix.py https://github.com/adafruit/circuitpython/blob/main/docs/shared_bindings_matrix.py#L67 but doesn't appear to be added in the mk file.

The wiznet and socket have not been captured either.

@dhalbert
Copy link
Collaborator

I think most of this has been handled in one way or another. Closing. More specific issues can be opened if wanted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good first issue Hacktoberfest Beginner friendly issues for Hacktoberfest event
Projects
None yet
Development

No branches or pull requests

6 participants