Doc: Search functionality does not work

[jjimenezshaw]

In the documentation in readthedocs, the Search functionality does not return anything. It stays "Searching..." forever.

https://python-geojson.readthedocs.io/en/latest/search.html?q=point&check_keywords=yes&area=default

[jjimenezshaw]

@mwtoews that happened also during the migration to readthedocs in PROJ. Do you remember what happened?

[mwtoews]

The fix was from OSGeo/PROJ@fd1b61e

But I don't even see how this can be done for this repo. Also, the docs for this repo is only one page, so if anything the search should be disabled.

[jjimenezshaw]

Thanks!

Search is the most noticeable thing, but there are other controls that do not work, like the version selector in the bottom left part "v: latest", or the whole menu button (burger button) when using it in a mobile device.

[mwtoews]

Yeah, I noticed the non-working controls too, which was the same as from the broken PROJ docs too. It's probably missing sphinxcontrib.jquery from the extensions list.

[rayrrr]

@mwtoews et al., thanks for reporting this issue and providing some tips. I'm looking into it now.

[blaisep]

jazzband/help#349 (comment)
@mwtoews , @jjimenezshaw

these files are missing in master:
OSGeo/PROJ@fd1b61e#diff-b958e0b3bc83edf72c782356993bf399fe683350ec85f2a59d2b5c03d3930d38

we need them , or something similar,
we also need a .readthedocs.yaml that looks something like this:

# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

build:
  os: ubuntu-22.04
  tools:
    python: "3.10"

sphinx:
  configuration: docs/source/conf.py

python:
  install:
  - requirements: requirements.txt
  - method: pip
    path: .

[rayrrr]

The above-mentioned PR, #227, is an attempt to fix this issue based on the above discussion. @blaisep and/or @mwtoews would you be kind enough to give it a review?

Basically, I used sphinx-quickstart to get a foundation, and then made some tweaks based on your recommendations.

[rayrrr]

@blaisep et al., I went ahead and merged the fix for this without review since it didn't touch any package functionality, and the issue is now resolved. Thanks for reporting it @jjimenezshaw.