pdoc
pdoc copied to clipboard
Support MkDocs themes
pdoc3 works really fantastic, but can i use the material for mkdocs theme ? Is it possible now ? or may be in future ?
Many thanks for your help
Not currently and no plans, immediate or otherwise. MkDocs themes cater to MkDocs output, expect certain defined variables, the two pieces of sotware rely on two different templating languages (Jinja2 vs Mako) ...
It would take, if I'm not mistaken, significant effort to make this (maybe) work. I'm not willing to look into it.
Instead, pdoc uses, so far, a simplish one-file HTML template you can customize to your will. An example of severely customized template is Hikari API docs.
Additionally, there's issue https://github.com/pdoc3/pdoc/issues/152. Fix that (fairly low-effort), and you'll do many users a favor.
It would certainly help to be able to output real markdown files instead of rst formatted ones.
What do you mean by rst formatted?
What is output by pdoc module is Python Markdown with a few extensions, which MkDocs can be configured to enable. Additionally, text.mako can be overridden to output some other style.