Sphinx уже подходит для документации на C ++?
Я хочу опробовать генераторы документации для нового проекта на C ++. Я думаю, что мои варианты либо Doxygen или Sphinx. Поскольку у меня есть проекты на Python, для которых я хотел бы использовать Sphinx, мне интересно, является ли Sphinx правильным выбором и для C ++. сфинкс веб-сайт заявляет, что C ++ поддерживается, но я не смог найти документ, чтобы начать работу с документацией C ++.
Подобный вопрос уже был обсуждается на Stackoverflow и основной ответ заключает:
еще не полностью пригодный для использования,
но продолжай смотреть
Поскольку обсуждение более года, Интересно, остается ли этот вывод в силе? Должен ли я выбрать Doxygen вместо Sphinx для моей документации C ++?
Решение
Sphinx не может самостоятельно извлекать документацию из источников C ++. Тем не менее, есть расширения, в первую очередь вздохнуть, которые используют Doxygen для извлечения документации из C ++. Я не проверял ничего из этого.
Другие решения
Для C ++ Doxygen очень хорош; Поддержка Сфинкса C ++ осуществляется через Doxygen (используя вздохнуть).
Вы хотите иметь только один инструмент для двух языков, чтобы улучшить удобство обслуживания. Doxygen может генерировать документацию из кода Python, поэтому я советую вам использовать Doxygen для обоих источников, если это возможно. Вот учебник для Doxygen и Python.