search

NiklasRosenstein / pydoc-markdown

Create Python API documentation in Markdown format.
http://niklasrosenstein.github.io/pydoc-markdown/
Other
453 stars 102 forks source link

extras not handled properly? #256

Closed odoublewen closed 2 years ago

odoublewen commented 2 years ago

Environment

Describe the bug

The extras do not get installed, when I use pip or pipx to install pydoc-markdown. I've tried both:

pip install pydoc-markdown[novella] and pipx install pydoc-markdown[novella]

Both commands complete without error, but without installing package novella. Perhaps this is a bug with the poetry packaging of this project?

I've confirmed that I can install "extras" from other packages, e.g., pip install "dask[dataframe]" gives me the expected extras.

Expected behavior

I expect novella to be installed, as specified here: https://github.com/NiklasRosenstein/pydoc-markdown/blob/develop/pyproject.toml#L51

NiklasRosenstein commented 2 years ago

Hey! Thanks for raising this issue. You're right, this doesn't quite work. The extra is installed by Pipx, but it doesn't recognize the "novella" script as one that should be linked into your PATH because it comes from a dependency. I should update the documentation here.

To use it with Pipx, you either need to pass the --include-deps flag (thought this also adds commands from other dependencies, such as docspec, docspec-python, normalizer, watchmedo, yapf and yapf-diff), or install novella with Pipx instead and inject Pydoc-Markdown.

$ pipx install novella
$ pipx inject novella pydoc-markdown

Let me know how this works for you and I'll fix the docs!

Cheers,

odoublewen commented 2 years ago

Yes, your suggestion did solve this problem. Thanks.