Skip to content

[FEATURE]: mcdoc tool enhancement wishlist #1542

@willend

Description

@willend

It would be nice with these additions / improved features for mcdoc / mxdoc:

Comp docs:

  • Automatic example search / link - dynamically list example instrs that includes the comp

Sphinx

  • Create a mcdoc mode to write sphinx docs from the comp information
  • Create a mcdoc mode to write sphinx docs from the instr information

Lint mode

  • Give warnings when a comp / instr does not follow "standards", i.e. when doc strings are not successfully parsed etc.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions