Skip to content
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.

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

Support MkDocs themes #284

Open
aahnik opened this issue Nov 13, 2020 · 3 comments
Open

Support MkDocs themes #284

aahnik opened this issue Nov 13, 2020 · 3 comments
Labels
enhancement New feature or request

Comments

@aahnik
Copy link

aahnik commented Nov 13, 2020

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

@kernc kernc changed the title Can pdoc3 support material for mkdocs theme in future ? Support MkDocs themes Nov 13, 2020
@kernc
Copy link
Member

kernc commented Nov 13, 2020

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 #152. Fix that (fairly low-effort), and you'll do many users a favor.

@m1racoli
Copy link

It would certainly help to be able to output real markdown files instead of rst formatted ones.

@kernc
Copy link
Member

kernc commented Nov 24, 2020

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.

@kernc kernc added the enhancement New feature or request label Nov 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

No branches or pull requests

3 participants