pdoc3 / pdoc3/pdoc

search always gives no results

Open
#328 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.2k
Forks
146
PR merge metrics
No merged PRs in 30d

Description

Expected Behavior

The search should return a list of results.

Actual Behavior

The search always returns No results.

Steps to Reproduce
  1. Generate docs with a config.mako in this style:
<%!
    git_link_template = 'https://github.com/thesadru/genshinstats/blob/{commit}/{path}#L{start_line}-L{end_line}'
    google_search_query = '''
        inurl:github.com/thesadru/genshinstats
        site:thesadru.github.io
    '''
%>
  1. Try to search anything
alternatively just search on the Github pages I'm trying to use

https://thesadru.github.io/pdoc/genshinstats/

Additional info
  • pdoc version: 0.9.2

I'm so sorry if this is some obvious bug, but I just can't figure out why.

screenshot:
image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue with pdoc 0.9.2 by generating documentation using the shown config.mako, then search the generated site linked in the report. Compare the result with the expected behavior: searches should return matching documentation results instead of “No results.”

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, search
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.