Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation & Swig Overhaul #1950

Open
2 tasks
FFroehlich opened this issue Jan 19, 2023 · 2 comments
Open
2 tasks

Documentation & Swig Overhaul #1950

FFroehlich opened this issue Jan 19, 2023 · 2 comments

Comments

@FFroehlich
Copy link
Member

FFroehlich commented Jan 19, 2023

Documentation:

  • add documentation for enum classes

Swig:

  • Add more ignores for classes/functions that are more confusing than helpful for the general user (like amici.amici.backtraceString)
@dweindl
Copy link
Member

dweindl commented Jan 19, 2023

  • add documentation for ExpDataView/ReturnDataView to sphinx

dweindl added a commit that referenced this issue Feb 12, 2023
@dweindl
Copy link
Member

dweindl commented Feb 12, 2023

* [ ]  add documentation for enum classes

That's gonna be a bit of a pain. This will require AST-walking to extract the enum member documentation (some example), unless SWIG will start using typing.Annotated at some point. Documentation of the enum itself (not it's members) won't be accessible, as far as I can see.

dweindl added a commit that referenced this issue Feb 13, 2023
* module-level variables to sphinx
* add/update docstrings
* typos, cross-reference
* ...

see also #1950
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants