search

libsemigroups / libsemigroups_pybind11

Python bindings for the libsemigroups C++ library for semigroups and monoids
https://libsemigroups.github.io/libsemigroups_pybind11
GNU General Public License v3.0
6 stars 7 forks source link

Update the autodoc directive to improve overloaded functions #160

Closed Joseph-Edwards closed 7 months ago

Joseph-Edwards commented 7 months ago

This PR improves how overloaded functions get rendered in the documentation. Specifically, it formats them in the same that non-overloaded functions get formatted, and adds a level of indentation.

I decided to use this directive to override the standard autoclass and autofunction directives, since it provides a superset of their functionality. The only downside that I can see is that this causes a directive already registered warning. If this is undesirable I can call it something else.

Joseph-Edwards commented 7 months ago

I've just noticed a few problems with this, specifically with automodule. Fixing them now.

james-d-mitchell commented 7 months ago

@Joseph-Edwards looks good, but needs to be rebased please