How to integrate doc and tutorial coming from opencv_contrib into docs.opencv.org/trunk and questions regarding samples naming conventions (Bug #3560)


Added by Alexandre Benoit about 11 years ago. Updated over 9 years ago.


Status:Open Start date:2014-02-18
Priority:Low Due date:
Assignee:Maksim Shabunin % Done:

0%

Category:build/install
Target version:3.1 Estimated time:0.50 hour
Affected version:branch 'master' (3.0-dev) Operating System:Any
Difficulty:Easy HW Platform:Any
Pull request:

Description

Hi,
some of the contrib modules of opencv 2.4.x have been moved to the new opencv_contrib repo for opencv 3.x but their existing doc and tutorial do not appear anymore in the online doc (docs.opencv.org/trunk). Then, how to make it come back ?
I guess it will be activated when the buildfarm will be able to check opencv_contrib. So this would only be a question of project setup that will be solve in some time, but is there a planning about it ?
Then, during this transition (and next) what are the guidelines for contrib developpers ?
=> how to setup tutorials (where to place them ? (in the opencv_contrib/doc/modulename/ folder as it has been done for the bioinspired module tutorial ?) But how to integrate it into the official doc. On individual plateforms, the addition of opencv_contrib with cmake directly targets opencv_contrib/modules folder thus ommiting opencv_contrib/doc ?
=> regarding module samples, how to prepare them ? It would be more convenient if they follow the same name conventions as in the opencv core, for example "cpp-example-mydemo" or "cpp-example-mymodule-mydemo" instead of the current "example_mymodule_mydemo". Currently, samples that are automatically compiled are placed into the opencv_contrib/modules/myModule/sample but sub directories are not considered.

If official guidelines exist, i can describe them in the general readme files to help opencv_contrib developers.
This would help/encourage people propose new methods.
Thanks.

Thanks.


Associated revisions

Revision 622cf566
Added by Vadim Pisarevsky about 10 years ago

Merge pull request #3560 from ilya-lavrenov:sse_remap

History

Updated by Alexander Karsakov about 11 years ago

  • Status changed from New to Open

Updated by Maksim Shabunin almost 10 years ago

  • Target version changed from 3.0-alpha to 3.0

Updated by Maksim Shabunin almost 10 years ago

After transition to doxygen documentation, some of problems become obsolete. All documentation from contrib repository is generated from corresponding header files. Tutorials should be put into <module>/tutorials folder and additional documentation pages and images to <module>/doc folder.

There is also documentation writing guide: http://docs.opencv.org/3.0-rc1/d4/db1/tutorial_documentation.html

For now there are two questions exist:

  • How to organize generated tutorials from contrib repository? (they are represented as single pages in corresponding section at this moment http://docs.opencv.org/3.0-rc1/pages.html)
  • How to name built samples from contrib repository and do we need to build samples from subfolders (<module>/samples/**)?
  • Priority changed from Normal to Low
  • Assignee changed from Ilya Lavrenov to Maksim Shabunin
  • Target version changed from 3.0 to 3.1

Updated by Maksim Shabunin over 9 years ago

Issue has been transferred to GitHub: https://github.com/Itseez/opencv/issues/4702

Also available in: Atom PDF