Search Index does not contain any terms under objnames

Open

#9,934 opened on Dec 3, 2021 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

html search type:bug

Dominant language: Python
Stars: 8k
Forks: 2.6k
PR merge metrics: No merged PRs in 30d

Description

Describe the bug

Upon searching for a term that appears in a (sub-section) heading the results are not displayed correctly. [Refer to second screenshot]
I have checked the searchindex.js files and the objnames key does not have any values. Because of this empty list the anchor related links are not generated.

How to Reproduce

$ git clone https://gitlab.com/YottaDB/DB/YDBDoc.git
$ cd YDBDoc
$ make html
$ python3 -m http.server 8000 --d StyleGuide/_build/html/
$ # search for the term "language"

Expected behavior

The search results should contain direct links to the sub-sections.

Referring to the screenshots provided:
Language Usage should be displayed as a link under Style Guide.

Your project

https://gitlab.com/YottaDB/DB/YDBDoc

Screenshots

Contents
Search

OS

Linux (Ubuntu 21.10)

Python version

3.9.7

Sphinx version

4.3.1

Sphinx extensions

sphinx.ext.autodoc, sphinx.ext.doctest, sphinx.ext.coverage, sphinx.ext.mathjax, sphinx.ext.githubpages, sphinxprettysearchresults

Extra tools

No response

Additional context

https://gitlab.com/YottaDB/DB/YDBDoc/-/issues/237

Contributor guide

Open the contributing guide

First steps

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

Research direction

Reproduce the issue in the YDBDoc repository with make html, then serve StyleGuide/_build/html/ and search for "language". Inspect the generated searchindex.js, especially the empty objnames data and missing anchor links. Done means subsection headings such as Language Usage appear as direct links under Style Guide.

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: 45/100