pdoc
pdoc copied to clipboard
pdoc3
:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
### Expected Behavior Top-level variables from module file documented, e.g. SQL_SERVER_MAX_VALUES_IN_INSERT = 1000 #: The maximum number of values in an insert statement for sql server ### Actual Behavior They...
Nested classes are incorrectly parsed as class variables. This commit fixes that and adds a method `all_classes` in `Module` that returns even the nested classes. Thanks, Angelos
GitHub pages are a common way to host documentation for sites. They require one of the following to host in source code: * master branch /docs folder * master branch...
I've seen HTML websites that simulate multiple pages in a single page. It would be nice to have an option in pdoc3 to generate a single .html file that would...
Hey, I think we all love Darkmodes. What about pdoc? I think a default integrated Darkmode would be great! What do you think about something like this? Thank you for...
### Expected Behavior The [numpy docstring guide](https://numpydoc.readthedocs.io/en/latest/format.html#documenting-classes) allows for a *Methods* section where you could list class member functions. I expect this section to be formatted similar like the Parameters...
Hello, When I tried to use offline search functionality I get such error in pop-up window: ``` Error importing module doc-search: Traceback (most recent call last): File "/home/al-pa/localPython/py380/lib/python3.8/site-packages/pdoc/__init__.py", line 225,...
I used pdoc3 do document my python package https://github.com/danleonte/Ambit_Stochastics. In particular, i used to run ```pdoc3 --html ambit_stochastics```` or ```pdoc3 --html ambit_stochastics --force```` When I try to do it now,...
Currently, the `>>>` and `...` in Python REPL snippets are selectable in HTML docs (much as they are here, on Github): ```py >>> mylist = [ ... 0, 1, 2,...
### Expected Behavior To generate an offline document, using pdoc, I found that I can generate pdf document but the pdf doc seems a little confusing. The html output is...
