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

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

Заметка про PipEnv

Pipenv: Python Dev Workflow for Humans

{i} Пример.

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

Установка:

   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

AudoDoc

Пример.

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

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

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

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

Д/З

  1. Завершить регистрацию семестрового проекта

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

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

LecturesCMC/PythonDevelopment2021/08_Documenting (last edited 2021-04-10 19:03:30 by FrBrGeorge)