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

Add docstrings to Python interface #11

Closed
casadibot opened this issue Oct 31, 2012 · 0 comments
Closed

Add docstrings to Python interface #11

casadibot opened this issue Oct 31, 2012 · 0 comments

Comments

@casadibot
Copy link
Member

The Python user should be able to obtain the same information as is given to doxygen.

Created by jaeandersson at: 2010-10-29T14:57:36
Last updated at: 2010-12-29T21:24:11


Comment 1 by jgillis at 2010-12-29T21:13:37

Preliminary workflow is present now, and described https://sourceforge.net/apps/trac/casadi/wiki/gendoc here.

The http://casadi.sourceforge.net/api/python/html/index.html Python documentation uses sphinx's autodoc feature to import docstrings. Docstrings are generated by a doxygen tool.

The result can badly use some clean-up.

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