Improve/Augment examples
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
- Refactor C++ examples : https://github.com/f3d-app/f3d/issues/2615
- Port C++ examples to other bindings:
- Add automated testing of the python examples: https://github.com/f3d-app/f3d/issues/2616
- Display (C++, python) examples in the website
- Add proper framework examples (Qt, GLFW, Others?): https://github.com/f3d-app/f3d/issues/2009
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)
May be we could try to add python API doc generated by sphinx to actual F3D documentation (in Bindings section).
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.
And then what kind of example would you add ?
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.
@snoyer @Meakk : please provide more ideas and concrete solutions :)