pdoc
pdoc copied to clipboard
pdoc3
:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
When I include an html file containing some Javascript using [.. include::](http://docutils.sourceforge.net/docs/ref/rst/directives.html#including-an-external-document-fragment) it does not get rendered in the documentation. You can find an html file to reproduce the behaviour...
firstly, this program is awesome. thank you. this may be asking too much from pdoc3, but in my code i usually have comment sections which are like markdown headings to...
### Expected Behavior pdoc test.py --skip-errors --html -f Should generate an html doc and skip import errors ### Actual Behavior Import Error is raised :ModuleNotFoundError, and html file is not...
### Expected Behavior I don't know if it's "expected" behavior per say, of feature/change request. I'd like a way to have `ReferenceWarning: Code reference mymodule.erroneous_reference in module "mymodule" does not...
### Expected Behavior HTML files end with a newline. ### Actual Behavior HTML files do not end with a newline. Github flags this as an issue. ### Steps to Reproduce...
### Summary If a [PEP224](https://peps.python.org/pep-0224/) style docstring is used for a global variable of type `Callable`, that is assigned a function re-exported from another package, the custom docstring is not...
### Expected Behavior The strike through to happen https://i.imgur.com/iZsP31F.png ### Actual Behavior The strike through does not happen, and I am left with extra `~`s https://i.imgur.com/ePnQrZj.png ### Steps to Reproduce...
Hello, I'm using pdoc3 with lunr_search, it helps me a lot and produces very nice documentation without much effort, many thanks to the developers. I just have one problem with...
### Expected Behavior Inline math delimited with `$ ... $` should work in html output out of the box with `--config latex_math=True` specified. It is supported in **pandoc** ([link](https://pandoc.org/MANUAL.html#math-input)), **GitHub**...
Fixes https://github.com/pdoc3/pdoc/issues/158 Closes https://github.com/pdoc3/pdoc/pull/427
