-
-
Notifications
You must be signed in to change notification settings - Fork 221
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
Improve/Augment examples #590
Comments
Adding python example should also be considered |
Hey I'm currently playing with python bindings. And I miss a lot some example to understand how it works exactly. I'm trying to reproduce actual CPP examples in python (I can put it in a PR if you want). But it's very slow because I miss Python API documentation like class, methods, and attribute (like Read the docs or Furo). May be we could try to add python API doc generated by sphinx to actual F3D documentation (in Bindings section). And then what kind of example would you add ? (may be I can add it to the PR too in both Python and CPP) |
Definitely! If you want to work on that you'd be very welcome! You can look at the python tests, its the best we have as a documentation for now.
Anything really, copying the C++ examples would be a start |
Python examples have been added, Ill update the issue to have a more coherent plan for examples in general. |
Examples are more and more outdated, setting to improve for 3.0 if possible |
Context
F3D also contains the libf3d, a C++ library with different bindings.
We currently provide a few examples in C++ and python.
F3D also automatize the building and testing of C++ example, which are validated in CI.
These examples should be augmented, ported and shared.
Suggested improvements
The text was updated successfully, but these errors were encountered: