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.

Sign up for GitHub

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

Jump to bottom

mcdoc tool enhancement wishlist #1542

Open

willend opened this issue Jan 5, 2024 · 0 comments

Contributor

willend commented Jan 5, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment