It looks like the rtd builds have actually been breaking since I added the notebook examples, I just couldn't notice it then! I've solved both the uv issue and the example notebooks issue.
It did require lowering the rtd fail_on_warning setting, but given the number of other issues we have with the docs at the moment, I think that's acceptable until we get them to a stable state.
I've also enabled rtd build on pull requests so we can catch this before merging next time.
I identified an issue with the directivity_example.ipynb notebook pointing to bugs in the directivity.py code. Opened #32
Documentation configuration updates:
.readthedocs.yaml: Updated the Read the Docs configuration to use a new version format, adjusted the build commands to use uv via a script, and modified the fail_on_warning setting.
README updates:
README.md: Added a Read the Docs badge to the README file.
Nitnelav
commented
3 weeks ago
Fixed!
It looks like the rtd builds have actually been breaking since I added the notebook examples, I just couldn't notice it then! I've solved both the uv issue and the example notebooks issue.
It did require lowering the rtd
fail_on_warningsetting, but given the number of other issues we have with the docs at the moment, I think that's acceptable until we get them to a stable state.I've also enabled rtd build on pull requests so we can catch this before merging next time.
I identified an issue with the
directivity_example.ipynbnotebook pointing to bugs in thedirectivity.pycode. Opened #32Documentation configuration updates:
.readthedocs.yaml: Updated the Read the Docs configuration to use a new version format, adjusted the build commands to useuvvia a script, and modified thefail_on_warningsetting.README updates:
README.md: Added a Read the Docs badge to the README file.Example references updates:
docs/source/directivity_example.nblink: Renameddirectivity_example.ipynbnotebook to avoid a naming conflict withdirectivity.rst.docs/source/index.rst: Updated the example list to replacedirectivitywithdirectivity_example.