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

extras not handled properly? #256

Closed
odoublewen opened this issue Mar 28, 2022 · 2 comments
Closed

extras not handled properly? #256

odoublewen opened this issue Mar 28, 2022 · 2 comments
Assignees

Comments

@odoublewen
Copy link

Environment

  • Pydoc-Markdown Version: v4.6.3
  • Python Version: v3.8.6
  • Operating System: macos

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
Copy link
Owner

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
Copy link
Author

Yes, your suggestion did solve this problem. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants