воскресенье, 11 декабря 2016 г.

CG Event 2016, Материалы к выступлению: GIT


Не большая презентация о GIT
part 2: GIT
пример работы с GIT на примере простых Nuke скриптов
git: video 1
git: video 2

так можно переопределить текстовый редактор Vim при commit 
git config --global core.editor "'D:/Program Files/Notepad++/notepad++.exe' -multiInst -notabbar -nosession -noPlugin" 
git config -l  

чтобы достучаться через proxy
git config --global http.proxy http://[user]:[password]@[ip adress]:8080 
git config --global --get http.proxy

добавить все файлы 
git add .

исключить некоторые типы файлов из добавления в репозиторий
нужно создать файл .gitignore его содержание:
/.sources 
/docs 
*.bak 
*~ 
*.db 
*.pyc 
файлы из указанных папок и указанных типов не будут добавляться в репозиторий  

четверг, 8 декабря 2016 г.

How can I create documentation with sphinx library

# генерация содержимого папки lib в папку docs/rst
sphinx-apidoc -o docs/rst .

# генерировать документацию
make html

для преодоления ошибок экранируем символы * обратной чертой \
"\*.py"

комментарии пишем с пропуском строки перед аргументами и внимательно относясь к отступам. Например:
text

arg:
   comment

in the comment you can print :
for bold string:
- **parameters**, **types**, **return** and **return types**::

for parametrs

parameters using :param <name>: <description>
type of the parameters :type <name>: <description>
returns using :returns: <description>
examples (doctest)
seealso using .. seealso:: text
notes using .. note:: text
warning using .. warning:: text
todo .. todo:: te

Постоянные читатели