cyclopts Mkdocs documentation generator

With the release of v4 support for a Sphinx documentation generator was added. Following #180 and especially the comment from @danielgafni I want to open this issue to ask for mkdocs support. Maybe if the foundations of such a generator are already here with Sphinx, this may also be possible in form of community contribution?

Oct 21 '25 11:10 relativityhd

It shouldn't be too hard now that we have v4; I'll make a PR soon for this, but will certainly need testers before merging since I don't have mkdocs experience (but i've been intending to give it a try at some point).

Oct 21 '25 14:10 BrianPugh

Sure, I can help to test it! Just ping me then, I should see it.

Oct 21 '25 14:10 relativityhd

Same!

I've adopted Cyclopts for a new project I'm working on. Will be happy to test mkdocs.

Oct 21 '25 15:10 danielgafni

Overall it's working well for me! Here are some issues I've observed:

TOC lacks nesting for subcommands

For some reason commands are truncated to a single word

Again, it would be nice to display env variables as well

Live url: https://anam-org.github.io/metaxy/main/reference/cli/

Oct 29 '25 00:10 danielgafni