При написании любой программы одним из важных этапов является создание документации или инструкции для пользователя. Данный процесс сам по себе трудозатратен, а если над проектом работает несколько человек, то одним файлов в формате Word обойтись уже не получиться.
В одной из прошлых статей мы рассмотрели создание документации исходного кода для библиотеки С++ с использованием Doxygen и CMake. Сегодня мы создадим документацию для самой программы с использованием Python Sphinx и CMake.
Doxygen больше всего подходит для автоматизированного создания документации именно исходного окна программы. Python Sphinx идеально подходит для создания документации самой программы, так как содержит больше возможностей для её описания и разметки, но при этом может создавать и документацию на программный код.