[ENH] Sphinx docs?

[inducer]

Sphinx, at least if appropriately configured, likes to generate references to types encountered in annotations. While there are several flaws with this currently, the idea seems vaguely desirable. optype doesn't quite fit into this picture because it does not offer Sphinx documentation that these links could be pointed at.

[jorenham]

Are you talking about those inventory thingies? Because I know that those can indeed be very handy, also for mkdocs.

I'm not at all familiar with sphinx (and the syntax scares me a bit haha), but if this is something that can also be done with mkdocs, then I have no objections.

[inducer]

Are you talking about those inventory thingies?

Yes, those!

I'm not at all familiar with the mkdocs ecosystem, but this PR seems related.

If you're open to it, I could try and throw together a rudimentary Sphinx setup for you all if you like. Maybe you'll grow to like it. 🙂

[jorenham]

Yea seems to be a thing: https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories

It's apparently as simple as setting:

plugins:
- mkdocstrings:
    enable_inventory: true

So I suppose that it's the rest of the docs that's the difficult part then 😜

[jorenham]

Oh and for the sake of expectation management: I don't have a lot of bandwidth at the moment. But if you're willing to mess around with this yourself, then I'd certainly be cheering you on 👌🏻.