search

mkdocstrings / pytkdocs

Load Python objects documentation.
https://mkdocstrings.github.io/pytkdocs
ISC License
50 stars 32 forks source link

[BUG] pytkdocs must be installed with 'numpy-style' #104

Closed rodrigomologni closed 3 years ago

rodrigomologni commented 3 years ago

Describe the bug

mkdocs build is producing the following message: pytkdocs must be installed with 'numpy-style' extra to parse Numpy docstrings. I verified that this warning is not being displayed because of the absence of numpy-style, but because of the absence of docstring_parser. I suggest to include this package in the mkdocstrings or pytkdocs requirements. mkdocs build produced documentation with NumPy style after the installation of the docstring_parser package.

System (please complete the following information):

pawamoy commented 3 years ago

As stated by the error message, you must install pytkdocs with the numpy-style extra, which means for example that you must use pip install 'pytkdocs[numpy-style]'. If you have it listed in a requirements.txt file, it's the same syntax.

rodrigomologni commented 3 years ago

pip install 'pytkdocs[numpy-style]'

Perfect! It's running! Thank you!

As stated by the error message, you must install pytkdocs with the numpy-style extra...

I suggest to include pip install pytkdocs[numpy-style] in the warning message. I didn't find instructions on how to install pytkdocs like numpy-style extra.

pawamoy commented 3 years ago

Yes, good idea, I'll do that, thanks :)

rodrigomologni commented 3 years ago

I thank you for your help! ;-)