-
Notifications
You must be signed in to change notification settings - Fork 669
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
Please generate HTML docs! #181
Comments
This seems to work fine. But there will be quite some dead links in the end.
|
I mean, yeah, but my point was stick that on github pages or something. |
But there are many broken links in the generated HTML files. So it does not seem to be a simple task. |
Sphinx could probably parse it and get better (looking and producing) documentation , you should take a look(still can be hosted on github pages) |
Please, please, PLEASE generate HTML docs for PyUSB.
The useability of pydoc is complete crap compared to a web page - With a web page, I can easily have multiple tabs open to different sections of the documentation, there is an actual navigation interface, etc... While PyDoc works, it's minimal at best, and straight out of the 80's at worst.
PyDoc can natively generate somewhat ugly, but quite functional documentation, and github can do the hosting.
For my own use, and because I don't want to use pydoc from the CLI, I wrote a little batch file:
This generates a few (10) HTML files, with functional internal links for types and such.
The text was updated successfully, but these errors were encountered: