Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: 🐛 enable quartodoc dynamic lookup (#948)
## Description This fixes the issue of quartodoc documenting the module/file instead of the function within the file with the same name. By actually loading the package (what they call "dynamic lookup"), I think `core`'s namespace (i.e., `__all__` in `__init__.py`) becomes available for quartodoc. This is instead of quartodoc using static analysis to look up the objects we want to document (which is the default). It now looks like this for `create_package_structure` locally: ![image](https://github.com/user-attachments/assets/fccc6419-ac6e-4b8d-ba56-c6d7dc334a5a) <img https://github.com/user-attachments/assets/fccc6419-ac6e-4b8d-ba56-c6d7dc334a5a) Instead of: ![image](https://github.com/user-attachments/assets/fd79732a-098b-4ee6-af58-25aa4482b692) Closes #944 Closes #943 Note: This is a stacked PR on #942 <!-- Select quick/in-depth as necessary --> This PR needs an in-depth review. ## Checklist - [X] Updated documentation - [ ] Ran `just run-all` --------- Co-authored-by: Luke W. Johnston <[email protected]>
- Loading branch information