How to make contributions to docs.opencv.org

document

asked 2013-07-26 11:11:35 -0600

artanis
131 ●2 ●7

updated 2013-07-26 11:56:17 -0600

AlexanderShishkov

3577 ●14 ●32 ●57

Hi all,

code.opencv.org says we can make a pull request on github to improve the documents on docs.opencv.org. However, I can't figure out how to change those documents.

It seems that each module has a directory named doc. Could you please tell me how they are related to the documents on doc.opencv.org?

Thanks very much. Artanis

edit retag flag offensive close merge delete

add a comment

1 answer

Sort by » oldest newest most voted

answered 2013-07-26 11:37:13 -0600

AlexanderShishkov

3577 ●14 ●32 ●57

docs.opencv.org is generated from RST documentation that is located in doc folders for each module.

You can find some information about RST format in this tutorial: http://docs.opencv.org/doc/tutorials/introduction/how_to_write_a_tutorial/how_to_write_a_tutorial.html#howtowritetutorial

So if you want to update documentation, you should change corresponding rst file in doc folder and create pullrequest with your modifications on github.