The main benefit here is that new generators are automatically incorporated into the docs. For example, we were already missing quadratic_assignment.
The cons are slightly ugly formatting at the top level
and no navigation within the page on the sidebar
IMO the maintenance benefit is worth it. If we wanted a summary table at the top, there are sphinx plugins, e.g. https://github.com/Chilipp/autodocsumm.
Another change made is that by using autodoc_type_aliases we can significantly shrink the size and increase the readability of the signature. IMO we should make that change in the SDK.
The main benefit here is that new generators are automatically incorporated into the docs. For example, we were already missing
quadratic_assignment.The cons are slightly ugly formatting at the top level
and no navigation within the page on the sidebar
IMO the maintenance benefit is worth it. If we wanted a summary table at the top, there are sphinx plugins, e.g. https://github.com/Chilipp/autodocsumm.
Another change made is that by using
autodoc_type_aliaseswe can significantly shrink the size and increase the readability of the signature. IMO we should make that change in the SDK.