Skip to content

Commit

Permalink
docs: 🐛 enable quartodoc dynamic lookup (#948)
Browse files Browse the repository at this point in the history
## 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
signekb and lwjohnst86 authored Jan 7, 2025
1 parent ce4d0a7 commit 5649fae
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ quartodoc:
dir: "docs/reference"
package: "seedcase_sprout"
parser: google
dynamic: true
renderer:
style: markdown
table_style: description-list
Expand Down

0 comments on commit 5649fae

Please sign in to comment.