Skip to content

Full api reference#423

Open
MSVermet wants to merge 4 commits intosodascience:developfrom
MSVermet:full-api-reference
Open

Full api reference#423
MSVermet wants to merge 4 commits intosodascience:developfrom
MSVermet:full-api-reference

Conversation

@MSVermet
Copy link
Copy Markdown
Collaborator

@MSVermet MSVermet commented Mar 24, 2026

  1. Added the automatically generated api reference for all modules, functions, and classes to the developer reference section under API reference (issue Add full API reference to documentation #404). Left the other API reference sections untouched.

Is it useful to keep the other API reference sections as well? Or shall I remove those and only have the full api reference there?

  1. And updated the license part in the toml (issue pyproject.toml update license #409)

@MSVermet MSVermet requested a review from qubixes March 24, 2026 09:32
@MSVermet MSVermet linked an issue Mar 24, 2026 that may be closed by this pull request
@MSVermet
Copy link
Copy Markdown
Collaborator Author

There seems to be a problem with setuptools version and the new standard format for license in the toml. Currently the toml has requires = ["setuptools==75.8.0".... If I change this to setuptools>=75 it is not failing anymore. But I'm not sure if this would break anything.

@MSVermet MSVermet linked an issue Mar 24, 2026 that may be closed by this pull request
Copy link
Copy Markdown
Member

@qubixes qubixes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's really nice, thanks! The structure is a little too hierarchical though, especially the demo module, which is quite nested. Also it shouldn't start at the metasyn level, but one higher. Also, if you could find how to remove the duplicate reference errors, that would be nice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

pyproject.toml update license Add full API reference to documentation

2 participants