Skip to content

Docs: Module Support Matrix Updates #2021

Closed
@sommersoft

Description

@sommersoft

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".

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions