-
Notifications
You must be signed in to change notification settings - Fork 30
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
Use pdoc rather than pdoc3 #324
Comments
Thanks. We weren't aware of this. I've raised a PR to remove pdoc3 and its generated documentation. Moving to pdoc isn't a simple find and replace, the pdoc tool works differently to pdoc3. We'll look into alternative docs generation tools in a follow-up. |
Removed pdoc3 in #325 We haven't moved to pdoc yet, so leaving this open. |
I have a big nest of documentation of a Python package. I started with read-the-docs, years later I switched to mkdocs, and finally, blissfully unaware of any controversy I went to pdoc3. Seeing the controversy and the use of the swastika by @kernc, I thought: what is the fuss about and do I have to switch? Two observations:
Also, converting to mkdocs with mkdocstrings is a long way to go, it will require very many edits in my docs.
Then, he really did a good job to turn a languishing pdoc into a well-working, reliable tool. The conflict with the original author of For me, that is "end of story" in the sense that I continue to happily use pdoc3. |
Is your feature request related to a problem? Please describe.
pdoc and pdoc3 are both continuations of a discontinued pdoc project. The two packages are conflicting. At present, mbed-tools uses pdoc3, however pdoc is a larger and more maintained library, also pdoc3 is the subject of some controversy.
Describe the solution you'd like
Change the project to depend on pdoc rather than pdoc3. As far as I can tell, this should be a near drop-in replacement, with just a handful of
pdoc3
s needing to be changed topdoc
s.Describe alternatives you've considered
The installation instructions say
Doing so mitigates this issue, but I think installation should be made as easy as possible without requiring a virtual environment.
The text was updated successfully, but these errors were encountered: