pdoc3 / pdoc

:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
https://pdoc3.github.io/pdoc/
GNU Affero General Public License v3.0
1.12k stars 145 forks source link

how to install pdoc3 when pdoc is already installed (and what are their differences) #376

Closed abubelinha closed 2 years ago

abubelinha commented 2 years ago

This is not a pdoc bug, but might be a pdoc3 bug. My brand new pdoc installation was running OK. With pdoc I mean https://github.com/mitmproxy/pdoc

Then I just discovered this github fork called pdoc3, but oddly, it does not link to the original pdoc project. I only found a tiny reference under the installation instructions in pdoc3.github.io pages:

As nothing else is said, I just tried to install pdoc3 to understand their differences.

But after installing pdoc3, now I am so confused about how should I call one or the other either from CLI or as a library. I would expect that pdoc command will still launch pdoc, whereas pdoc3 should be used to launch pdoc3. But that's not the case: both pdoc and pdoc3 calls are launching pdoc3. Is there a way to install one package which uses the same name, without affecting the previously installed one?

I also take the opportunity to ask about the differences (pros and cons) between these two packages. I would expect that pdoc3 has some improvements over pdoc, but I couldn't find info about them on pdoc3 site. Are they hidden somewhere?

Expected Behavior

install pdoc3 on a system where I already have pdoc, so I can keep using both of them

Actual Behavior

pip install pdoc3 made my current pdoc installation unusable

Steps to Reproduce

  1. pip install pdoc Successfully installed pdoc-8.1.0
  2. c:\python38\scripts\pdoc --version
    pdoc: 8.1.0
    Python: 3.8.7
    Platform: Windows-7-6.1.7601-SP1
  3. pip install pdoc3 Successfully installed pdoc3-0.10.0
  4. c:\python38\scripts\pdoc --version pdoc.exe 0.10.0 c:\python38\scripts\pdoc3 --version pdoc.exe 0.10.0
  5. OK. How can I call "the real pdoc" now ??

Additional info

kernc commented 2 years ago

Duplicate of https://github.com/pdoc3/pdoc/issues/131.

abubelinha commented 2 years ago

Sorry about not having found those duplicates. First of them, almost 3 years ago. Still no possible solution?

I also posted a question above, which still remains unanswered:

I also take the opportunity to ask about the differences (pros and cons) between these two packages. I would expect that pdoc3 has some improvements over pdoc, but I couldn't find info about them on pdoc3 site. Are they hidden somewhere?

Thanks in advance