Как вы создаете документацию?

Кажется, довольно часто появляется новый проект генератора документации с открытым исходным кодом, и я уверен, что множество платных сервисов для управления более качественной документацией.

В первую очередь ищу:

  • Документы по API
  • Документы по SDK
  • Документы по структуре кода (помимо тестов)
2 симпатии

С Sphinx очень приятно работать, и он существует уже давно. Я использовал его для проектов Python, проектов C ++ и некоторых вещей, не зависящих от языка программирования.

Также почти тривиально связать документы Sphinx с readthedocs.org. Для небольших частей документации (и многих личных вещей) я использую режим Org в Emacs. Режим организации поддерживает экспорт в самые разные форматы.

https://www.sphinx-doc.org/en/master/

5 симпатий