Документации и код размещены в Github
репозитории здесь.
docs
на Github
:mkdocs.yml
для размещения на ресурсе ReadTheDocs
.TypeDoc
для генерации кодовой документации.Такой способ документации показался нам более всего простым и спокойным. Прост в поддерживании и разворачивании совместно с проектом.
Просто коментируем свой код в исходниках и добавляем необходимые файлы .md
в папку docs
.
В конце генерируем документацию, коммитим и отправляем в Github
и все остальное делают сами сервисы. Мы работаем исключительно в редактре кода.
Generated using TypeDoc