pdoc
pdoc copied to clipboard
pdoc3
:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
I want `pdoc3` to skip everything in my project's the `tests` directory, but even after reading #99 I am unable to get it to do so. Steps taken: - Create...
pdoc is great! But I like to explore different themes. I only found one link to [hikari](https://www.hikari-py.dev/hikari) in the GitHub issues. Are there more community themes? It might be beneficial...
I am new to Python and very new to pdoc3. I have arranged my code in the following tree. ``` ├── activity │ ├── __init__.py │ └── activity.py ├── athlete...
The generated documentation for a property: ``` @property def weight(self) -> int: ... ``` is shown as "var weight : int" but it would be more useful if the fact...
### Expected Behavior Images are served by http server ### Actual Behavior Images return a 302 and a URL that ultimately results in a 404. ### Steps to Reproduce 1....
### Expected Behavior A way to include the `--http` mode's "Python module list" `index.html` as the root `index.html` of the `--html` output. ### Actual Behavior By default, there is no...
It would be very nice to be able to just look at the source code w/o all the comments. [Live Example](http://nfldb.derekadair.com/#nfldb.Play) If you expand play you can see that the...
### Expected Behavior No error thrown. I have a base class in a lib that I want to document and some of the methods are deliberately marked as `NotImplementedError`. ###...
### Expected Behavior I'd like my module docs to be rendered correctly in something like a GitHub `README.md` file. Problems are caused with Markdown Extra, I'd like to switch to...
