pdoc
pdoc copied to clipboard
pdoc3
:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
Hi guys. Thanks for releasing and mantaining pdoc. In my codebase, I have a class that inherits from an abstract class, and within this derived class, I have methods named...
This PR adds code to handle the import of the `sysconfig` module for Python >= 3.11
Fix for https://github.com/pdoc3/pdoc/issues/436
### Expected Behavior Create output for Python files with PEP224 class variable docstrings without warnings. ### Actual Behavior - .../pdoc/__init__.py:260: DeprecationWarning: ast.Str is deprecated and will be removed in Python...
I recently ran into a rather complex issue with pdoc and pybind modules. The signature detection peice of code can be very easily broken under specific conditions. ## Problem In...
Regardless of the intent and the explanations that @kernc provided in #152 and #310, the unfortunate reality (in much of the world) is that swastikas today are much more widely...
### Expected Behavior Output of pdoc.Module().text() generates a markdown file where the headings are not indented. Indentation in markdown creates block quotes, which is not the intended purpose the the...
### Expected Behavior I am currently including my readme markdown file in the documentation to make sure all information is up to date whenever it is changed in the readme....
Hi trying to run pdoc for a module but keeps coming up with a syntax error. The command used to run pdoc: ```bash pdoc {PKG_name} --html --output-dir public --config "syntax_highlighting=False"...
A somewhat ugly implementation of the option to append markdown extensions, as suggested in #158 by @MPvHarmelen. Limitations mentioned in the comments of that issue apply.
