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

pdoc and pdoc3 confusion #266

Closed
aahnik opened this issue Oct 8, 2020 · 3 comments
Closed

pdoc and pdoc3 confusion #266

aahnik opened this issue Oct 8, 2020 · 3 comments
Labels
duplicate This issue or pull request already exists upstream Issue affects a dependency of ours

Comments

@aahnik
Copy link

aahnik commented Oct 8, 2020

I went to the website linked in this GitHub repo. https://pdoc3.github.io/pdoc/

I did pip3.8 install pdoc3 as stated.

Then this below thing messed up everything

Screenshot from 2020-10-08 17-59-15

Markdown did not get rendered properly. Fenced code (inside ```) did not render.
And the HTML was not looking like shown in the website. Also links were not clickable

But when I used pdoc3 command instead of pdoc, everything got sorted. Fenced code got rendered with color highlighting.
and the look was great.

At the bottom of the rendered page there was a link that says

Screenshot from 2020-10-08 18-13-57

I clicked on the link and reached the website https://pdoc3.github.io/pdoc/, from which I took the topmost screenshot

@kernc
Copy link
Member

kernc commented Oct 8, 2020

Pdoc3 does install as pdoc:

pdoc/setup.py

Lines 39 to 44 in d8b9dbc

entry_points={
"console_scripts": [
"pdoc = pdoc.cli:main",
"pdoc3 = pdoc.cli:main",
],
},

The only reason this wouldn't work is by having a prior bin/pdoc installed and pip not overwrite it. I'm almost certain pip did produce a warning, though.

Related: #131

@aahnik
Copy link
Author

aahnik commented Oct 8, 2020

No pip did not produce any warning. It may be due to my system. There are multiple versions and virtual environments. May be I made some other mistake that messed up something.

But using pdoc3 changed my experience. Earlier I was frustrated and miserable.

Now seeing the ease of pdoc3 I have fallen in love with writing documentation.

Thanks a lot @kernc for this wonderful project.

No doubt pdoc3 is the best tool out there to generate docs.

@kernc
Copy link
Member

kernc commented Oct 8, 2020

Oh, my, I have doubts. 😅 Ymmv. But thanks! ❤️

@kernc kernc closed this as completed Oct 8, 2020
@aahnik aahnik changed the title Incorrect info in website linked with this repo pdoc and pdoc3 confusion Oct 8, 2020
@kernc kernc added upstream Issue affects a dependency of ours duplicate This issue or pull request already exists labels Oct 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
duplicate This issue or pull request already exists upstream Issue affects a dependency of ours
Development

No branches or pull requests

2 participants