flutter_opencv icon indicating copy to clipboard operation
flutter_opencv copied to clipboard

Document usage of functions in the official documentation

Open AdityaMulgundkar opened this issue 4 years ago • 1 comments

Currently, we have no documentation of the existing functions, but they are demonstrated in the examples at example/lib/main.dart under the runAFunction method.

Write base level documentation for the same in Sphinx, in the doc/source/index.rst file. Making changes to this file (or the files in this directory) will directly affect the documentation generated at https://flutter-opencv.readthedocs.io/en/latest/

Just fork the code; write the documentation; send across a pull request to this repository. Once the request is accepted, the documentation pages will rebuild. (i.e. you might want to run Sphinx locally in order to ensure everything works fine, but this is an extra step).

AdityaMulgundkar avatar Apr 19 '20 11:04 AdityaMulgundkar

Hi! I'd like to work on this. Do I need to create a rst file for all functions listed in runAFunction method?

pedr0luiz avatar Oct 26 '21 16:10 pedr0luiz