compas-dev / compas-dev/compas

Doc search only returns API reference matches

Open
#556 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
386
Forks
122
Avg merge
11d 46m
Merged PRs (30d)
1

Description

The search function of the docs is only showing matches in the API reference, and all the rest of the docs are ignored.

**To Reproduce**
Steps to reproduce the behavior:
1. Open docs, and search for anything present in the non API reference, eg. "Getting started"
2. Zero results

For example: [try this search](https://compas-dev.github.io/main/search.html?q=Getting+started&check_keywords=yes&area=default#)

**Expected behavior**
At least one match should be found.

**Additional context**
This does not happen with readthedocs search, so I am assuming it's not a sphinx issue but something we do in the preprocessing of search results. Considering the number of issues with had this preprocessing, should we just drop it?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.