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

GeoJSON Read the Docs not looking right #349

Closed
rayrrr opened this issue Nov 22, 2023 · 3 comments
Closed

GeoJSON Read the Docs not looking right #349

rayrrr opened this issue Nov 22, 2023 · 3 comments
Labels

Comments

@rayrrr
Copy link
Member

rayrrr commented Nov 22, 2023

The GeoJSON docs on Read the Docs do not look right. See issue reported at jazzband/geojson#224

And see the actual page here: https://geojson.readthedocs.io/en/latest

Issues:

  1. Search returns empty results page no matter the input
  2. Version chooser is not functioning, only docs for latest version can be accessed
  3. Generally has a 20th-century appearance compared to docs for well-configured Jazzband packages such as https://tablib.readthedocs.io

Should I follow the generic Read the Docs getting started tutorial and follow the instructions to the best of my ability, or do we have another preferred approach for Jazzband projects that I should follow, or should this be a roadie task?

@blaisep
Copy link

blaisep commented May 28, 2024

@rayrrr ,

good news,

  • The is obvious
  • The fix is easy

bad news

The Sphinx config is missing a conf.py which is the file that puts everything together.
I could suggest that you fix this yourself, but that would be cruel.
Since there seem to be some changes in the project's history, could you find the most recent conf.py and show it to me? If we can find a known good conf.py, I bet we can get this working in less than an hour.

@jjimenezshaw
Copy link

In case it helps, PROJ uses this conf.py file: /~https://github.com/OSGeo/PROJ/blob/master/docs/source/conf.py
PROJ also uses readthedocs: https://proj.org

@rayrrr rayrrr closed this as completed Aug 10, 2024
@rayrrr
Copy link
Member Author

rayrrr commented Aug 10, 2024

Thanks for the advice, folks. I implemented a solution from scratch using sphinx-quickstart and the docs are now functioning.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants