search

Toblerity / Fiona

Fiona reads and writes geographic data files
https://fiona.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
1.14k stars 202 forks source link

Broken online doc #1306

Closed loicdtx closed 10 months ago

loicdtx commented 10 months ago

Looks like the API documentation on ReadTheDocs is broken; here is the latest working build I could find

The sphinx logs of more recent build are full of

WARNING: autodoc: failed to import module 'collection' from module 'fiona'; the following exception was raised:
No module named 'fiona'
sgillies commented 10 months ago

@loicdtx Thanks for the report! Recently, RTD stopped provisioning builds with common packages, and we needed to add sphinx_rtd_theme specifically. This has been fixed in the maint-1.9 branch and now that I've merge 1.9.5 to the master branch, I expect it will be fixed there as well.

sgillies commented 10 months ago

Yep, there we go: https://readthedocs.org/projects/fiona/builds/22283040/.

loicdtx commented 10 months ago

Thanks @sgillies Although the RTD build completes, it does not appear to address the autodoc issue; same warnings in the logs and still no API doc

loicdtx commented 10 months ago

From the build logs it looks like fiona itself does not get installed.

How about adding this to .readthedocs.yaml (I just looked it up in rasterio)?

python:
  install:
    - method: setuptools
      path: .
sgillies commented 10 months ago

@loicdtx Do you have a minute to make a PR?