Добавить документацию

[sergey-s-betke]

Напрашивается подготовка документации к проекту.

Для этих целей стоит рассмотреть Sphinx (http://www.sphinx-doc.org/en/stable/, https://bitbucket.org/birkenfeld/sphinx-contrib/). Для него есть домен для CMake.

https://github.com/ondrejsika/sphinx-autodoc-example

https://bitbucket.org/klorenz/sphinxcontrib-cmakedomain

[sergey-s-betke]

И интегрировать документацию с http://read-the-docs.readthedocs.io

http://wahlnetwork.com/2017/01/06/switching-restructuredtext-readthedocs-github-project-documentation/

[sergey-s-betke]

Разметку - commonmark или restructured.

[sergey-s-betke]

Или же использовать Doxygen.

[sergey-s-betke]

О разработке домена для Sphinx: https://samprocter.com/2014/06/documenting-a-language-using-a-custom-sphinx-domain-and-pygments-lexer/

[sergey-s-betke]

https://github.com/ericholscher/read-the-docs-wtd-pdx-example

[sergey-s-betke]

http://doxygen.10944.n7.nabble.com/add-other-programming-languages-to-doxygen-td2679.html

[sergey-s-betke]

http://www.sphinx-doc.org/en/stable/

[sergey-s-betke]

https://samprocter.com/2014/06/documenting-a-language-using-a-custom-sphinx-domain-and-pygments-lexer/

[sergey-s-betke]

http://sphinx-autoapi.readthedocs.io/en/latest/

[sergey-s-betke]

https://leapon.net/files/Multiple%20language%20support%20for%20autodoc%20in%20Sphinx%20via%20ANTLR.html

[sergey-s-betke]

http://www.antlr.org/