Документирование

Строки документации

Заметка про плагины к VIM-у

Установка (в состав ALT входит в виде пакета, можно просто поставить его):

   1 $ mkdir -p ~/.vim/pack/run/start
   2 $ git clone https://github.com/vim-syntastic/syntastic  ~/.vim/pack/run/start/syntastic
   3 $ vim +"helptag ~/.vim/pack/run/start/syntastic/doc"

Техническое документирование

Sphinx

Сайт

Используется для всего, не только для Python.

Пример (см. методичку)

Оформление docstrnigs

AutoDoc

Пример.

BTW: Настройка syntasitc для проверки rst-файлов sphinx-ом:

Хостинг документации

(если успеем):

Документация в программном продукте

Документация на сайте

Д/З

  1. Предусмотреть в семестровом проекте
    • выгонку HTML-документации по API (sphinx.ext.autodoc или аналоги),

    • статическую документацию по проекту (sphinx, wiki, что угодно),
    • (пока без публикации)
    • Пример

LecturesCMC/PythonDevelopment2022/08_Documenting (last edited 2022-03-30 10:36:38 by FrBrGeorge)