pdoc

pdoc copied to clipboard

Cannot get search to work

1

### Expected Behavior After running in the project directory `pdoc3 --html --force -c lunr_search=True .` I expect to be able to have a working search box in my HTML documenation...

aflugge

### Expected Behavior/Steps to reproduce if we have a submodule `something` with a function `something` inside that submodule, both the function and submodule should appear in the generated docs. ###...

mivanit

see https://github.com/pdoc3/pdoc/issues/450

mivanit

### Expected Behavior pdoc should successfully build docs with `git_link_template = 'https://github.com/USER/PROJECT/blob/{commit}/{path}#L{start_line}-L{end_line}'` for classes with `property` or `cached_property` ### Actual Behavior ```python Python/Lib/site-packages/pdoc/html_helpers.py:580: UserWarning: format_git_link for failed: Traceback (most recent...

mivanit

Make it possible to ignore class members based on wildcard strings

2

I have a module that defines big nested data structure that is based on Pydantic. For the examples below, I use pydantic as an example even though this happens with...

ml-kalju

# Expected Behavior Markdown files end with a newline. # Actual Behavior Markdown files do not end with a newline. The [markdownlint](https://github.com/markdownlint/markdownlint) flags this as an issue. Steps to Reproduce...

xhujerr

RuntimeError: absolute path '.../dataclasses.py' is not a descendant of the current working directory or of the system's python library

1

Hi. In [fpdf2](https://py-pdf.github.io/fpdf2/) we have been using `pdoc3` for several years: thank you for maintaining this great tool! I noticed a warning in our execution log: https://github.com/py-pdf/fpdf2/actions/runs/13482969652/job/37670544099?pr=1374 ``` Traceback (most...

Lucas-C

Non-Python Type for pybind11 Module

6

### Expected Behavior When I try to document my codebase which contains a pybind11 module, pdoc seems to be trying to generate python code with a c++ function signature leading...

Queuecumber

A similar problem to #134 occurs after backticks have been used within a link text. Code: `Picture` object: A [`tikzpicture` environment](https://pgf-tikz.github.io/pgf/pgfmanual.pdf#subsubsection.12.2.1) is represented by a `Picture` object. Result:  The...

allefeld

pdoc3 skips a decorated function (callable object)

3

### Expected Behavior Generate the documentation for `add3` ### Actual Behavior Nothing is generated ### Steps to Reproduce 1. Create a script "pdoc_tt.py" as follows ```python from numba import cuda...

ShuhuaGao