mkdocstrings: mkdocstrings might not work with editable installs in the new setuptools

This should be supported in the next release of Griffe.

Finally, note that you don’t have to rely on Griffe’s ability to understand editable modules: you can tell it to search directly in src (now that you have a proper layout) with this:

# mkdocs.yml
plugins:
- mkdocstrings:
    handlers:
      python:
        paths: [src]

You’re welcome!

Also, it was working before because Griffe would not find gemdat and fallback on inspection, trying (and succeeding) to import it, and you were only injecting docs with ::: gemdat. Within the docs branch, you’re now also injecting docs for gemdat.plots, and it happens that inspect.getmembers returns submodules of the gemdat packages, except the plots submodule, probably because it’s a folder and needs to be imported to appear in its parent.

Yeah, I switched to the more conventional directory structure and all works as expected now. Thanks for your help debugging this!

Oh right, I didn’t notice modules were stored directly under src and not src/gemdat 😅 I would have immediately pointed at that otherwise 🙂

Ah I see it only happens in the docs branch: git checkout docs --

Workaround: using strict editable installs solves this. However, the implementation details are not finalized yet, and may change in the future.

Instead of:

pip install -e .

… we could use:

pip install -e . --config-settings editable_mode=strict

That’s perfect, thanks. I see we could regex-find the MAPPING value, to start at least. We’ll need to try editable installs for namespace packages as well (great to learn they support them), but that can be done later. By the way all this detection happens in Griffe, if someone wants to try and send a PR 😃 Otherwise I’ll eventually get to it.