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

Missing depandcies: pymdown-extensions, mkdocs-material #66

Closed
Mattwmaster58 opened this issue Mar 28, 2020 · 5 comments
Closed

Missing depandcies: pymdown-extensions, mkdocs-material #66

Mattwmaster58 opened this issue Mar 28, 2020 · 5 comments

Comments

@Mattwmaster58
Copy link

cloning the repo and installing with pip install mkdocstrings works, but as soon as mkdocs serve is run, the two aforementioned packages are nowhere to be found. Am I missing something?

@pawamoy
Copy link
Member

pawamoy commented Mar 29, 2020

Well, mkdocstrings is not supposed to depend on any theme. Currently it only supports the Material for MkDocs theme, but it's only that: support. Maybe we could add mkdocs-material as a dependency, but later it should be removed when more themes are supported (especially the native ones), and it could be quite confusing for users 😕

Right now I think it's best to warn users that they must install Material for MkDocs themselves. I'll update the README and docs. What do you think?

@Mattwmaster58
Copy link
Author

If I'm understanding the problem correctly something like this should suffice:

Note: this project currently only works with the Material theme of MkDocs at this time. Therefore, it is required that you have it installed.

@Mattwmaster58
Copy link
Author

And with regard to pymdownx, I assume that's this project is missing that dependency?

@pawamoy
Copy link
Member

pawamoy commented Mar 30, 2020

pymdownx is a dependency of mkdocs-material, and I don't believe we're doing anything in mkdocstrings that would require it as well.

pawamoy added a commit that referenced this issue Mar 30, 2020
@pawamoy
Copy link
Member

pawamoy commented Mar 31, 2020

Hmm in fact yes, we depend on pymdownx for the highlight jinja filter. I'll add it as a dependency. Thanks @Mattwmaster58

@pawamoy pawamoy reopened this Mar 31, 2020
@pawamoy pawamoy closed this as completed in 648b99d Apr 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants