Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docsearch not searching for foo:idx: entries #9477

Open
timotheecour opened this issue Oct 23, 2018 · 1 comment
Open

docsearch not searching for foo:idx: entries #9477

timotheecour opened this issue Oct 23, 2018 · 1 comment
Labels
Documentation Generation Related to documentation generation (but not content).

Comments

@timotheecour
Copy link
Member

timotheecour commented Oct 23, 2018

when a doc comment for a symbol (eg ospaths.lastPathPart) refers to a idx entry, eg baseName:idx:

proc lastPathPart*(path: string): string =
  ## like ``extractFilename``, but ignores trailing dir separator; aka: `baseName`:idx: in some other languages.

it (correctly) ends up in an entry in https://nim-lang.github.io/Nim/theindex.html
however, docsearch can't find these idx entries. /cc @rayman22201

Possible Solution

  • docsearch should work when searching for an idx entry (eg baseName should retrieve ospaths.lastPathPart)
  • theindex.html should show the symbol in which the idx entry was mentioned, eg:
baseName:
Module ospaths

should be like other entries:

baseName:
ospaths: lastPathPart(path: string): string
# or alternatively:
referenced in: ospaths: lastPathPart(path: string): string
  • the idx entry baseName should be a link instead of plain text in rendered html

Additional Information

@timotheecour timotheecour added the Documentation Generation Related to documentation generation (but not content). label Oct 23, 2018
@rayman22201
Copy link
Contributor

I think this is another issue that theindex.json will fix.
A lot of data has to be left out because the search code can't differentiate the data in html format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Generation Related to documentation generation (but not content).
Projects
None yet
Development

No branches or pull requests

2 participants