Aprakos-TS

Документация по скрипту aprakos.ts,
вычисления православных зачал для всего Пасхального года.


img


Документации и код размещены в Github репозитории здесь.

В создании документации используются три программы публикации и папка docs на Github:

  1. GitHub Pages (без тем).
  2. MkDocs, а точнее файл с таким именем mkdocs.yml для размещения на ресурсе ReadTheDocs.
  3. TypeDoc для генерации кодовой документации.

Для публикации же использовались два web-ресурса (сайта):

  1. Github Pages …смотри здесь
  2. ReadTheDocs … и здесь

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



img

Generated using TypeDoc