Скрипт обновления django trunk и генерации документации
Выкладываю полезный скритпик. При его запуске происходит update транка из svn-репозитария (при условии, что вы уже сделали checkout), а затем из обновлённых файлов генерируется документация. Таким образом ваши маны по джанго никогда не устаревают )
Локальная документация актуальна в первую очередь тем, у кого нет unlimit интернета или канал слишком узок. К примеру на моих 128 кбитах читать on-line django документации немного напряжно.
Собственно, скрипт:
rst2html - это утилита из пакета docutils
А тут [web-brains.com] можно посмотреть, как я организовал просмотр этой документацию в firefox. Достаточно удобно получилось - я всего лишь добавил в закладки ссылку на локальную папку.
UPD: Недавно переехал с FreeBSD на Gentoo. Тут несколько иной синтаксис у утилиты basename и rst2html имеет в названии суффикс py. Таким образом скрипт в gentoo приобрёл следующий вид:
Локальная документация актуальна в первую очередь тем, у кого нет unlimit интернета или канал слишком узок. К примеру на моих 128 кбитах читать on-line django документации немного напряжно.
Собственно, скрипт:
#!/bin/sh
cd /web/django_src
svn up
echo 'Generating html documentation'
cd docs
for f in $(ls *txt); do
echo $f
rst2html $f /usr/local/share/doc/django/$(basename -s .txt $f).html;
done;
rst2html - это утилита из пакета docutils
А тут [web-brains.com] можно посмотреть, как я организовал просмотр этой документацию в firefox. Достаточно удобно получилось - я всего лишь добавил в закладки ссылку на локальную папку.
UPD: Недавно переехал с FreeBSD на Gentoo. Тут несколько иной синтаксис у утилиты basename и rst2html имеет в названии суффикс py. Таким образом скрипт в gentoo приобрёл следующий вид:
#!/bin/sh
cd /web/django_src
svn up
echo 'Generating html documentation'
cd docs
for f in $(ls *txt); do
echo $f
rst2html.py $f "$HOME/doc/django/$(basename $f .txt).html"
done;



















Comments