API not updated or accurate

[goldmanm]

Our API is only somewhat automatic. It is automatic below the class level, but requires manual addition for new classes and modules.

The API seems to be years behind in adding new methods.

Also note that the Wiki doesn't describe the API updating.

It seems like we could do 3+ things:

1. move to an entirely automated api (we will lose the pretty formatting but everything will be accurate and docstrings will be utilized more effectively)
2. manually update the api pages that require manual updating (anything not stored in a Class structure)
3. deprecate the api (source code for the win!)
4. keep as status quo (confusion is a source of strength!)

[amarkpayne]

I think that having an accurate and up to date API is more important than having an out of date API that looks pretty. What would we use to do this? Can we try this out just to see what it would look like?

[mliu49]

#1273 updates some portions of the API. I mainly fixed updated things that I noticed while doing other things, so it isn't a thorough update.

We can definitely consider a fully automated API, although we would need to look into how to do that and exactly what that would look like.

[github-actions]

This issue is being automatically marked as stale because it has not received any interaction in the last 90 days. Please leave a comment if this is still a relevant issue, otherwise it will automatically be closed in 30 days.