jazzband / geojson

Python bindings and utilities for GeoJSON
https://pypi.python.org/pypi/geojson/
BSD 3-Clause "New" or "Revised" License
898 stars 120 forks source link

Doc: Search functionality does not work #224

Open jjimenezshaw opened 8 months ago

jjimenezshaw commented 8 months ago

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 commented 8 months ago

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

mwtoews commented 8 months ago

The fix was from https://github.com/OSGeo/PROJ/commit/fd1b61e71c23fe959799fe6a5320fcf5d99a7a93

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 commented 8 months ago

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 commented 8 months ago

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 commented 7 months ago

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

blaisep commented 1 month ago

https://github.com/jazzband/help/issues/349#issuecomment-2135230760 @mwtoews , @jjimenezshaw

these files are missing in master: https://github.com/OSGeo/PROJ/commit/fd1b61e71c23fe959799fe6a5320fcf5d99a7a93#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: .