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

After installing pdoc with pip it not recognised as an executable on Windows #127

Closed
epogrebnyak opened this issue Apr 14, 2017 · 3 comments

Comments

Projects
None yet
3 participants
@epogrebnyak
Copy link

commented Apr 14, 2017

Tried navigating to \Scripts, same result.

@BurntSushi

This comment has been minimized.

Copy link
Contributor

commented Apr 14, 2017

I don't understand Python on Windows, so you're probably on your own. I doubt pdoc is itself installed as a real executable. Maybe you need to run it with the Python interpreter? e.g., python path/to/pdoc.py or python -m pdoc?

@epogrebnyak

This comment has been minimized.

Copy link
Author

commented Apr 17, 2017

So far my best case for Windows is below:

  1. Download package from Github (e.g. download zip and unpack)
  2. In pdoc root directory run python setup.py install (as described in manual)
  3. Use python interpreter to run pdoc:
    python <your python install path>\Scripts\pdoc <package_or_file_path>

This got pdoc going for me on Windows.

Remaining question for me: can pdoc document a non-installed package, just a folder with __init__.py inside and several *.py files? I get an empty listing here:

>python D:\Continuum\Anaconda3\Scripts\pdoc kep2
Module kep2
-----------
@stevebrasier

This comment has been minimized.

Copy link

commented Sep 28, 2017

I think this is easy to fix; the script pdoc installs just needs to have a .py extension and the user needs to right-click a *.py file and set "open with.." to their Python executable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.