Рубрики
Без рубрики

Как настроить Turbogears 2 DOC Environment

Получите практические, реальные навыки Python на наших ресурсах и пути

Автор оригинала: Mike Driscoll.

В прошлом месяце я нашел несколько вопросов с Turbogears 2 Документация И парни на канале TG IRC рассказали мне, что я должен скачать документы и сделать что-то об этом. Увы, я не знал, что я делал, но с их руководством я получил код, и он был в основном создан. Тогда моя работа встала, и я забыл все об этом. Вчера я попал в очередной разговор о печальной форме, документы находятся в том же канале IRC, и на этот раз я решил сделать это правильно. Вот как вы можете настроить, чтобы вы могли помочь тоже!

Если вы просто хотите прыгнуть, прочитайте короткие направления в конце.

Во-первых, вам нужно иметь Виртуальский и SetUpeWools Установлен в вашем Python по умолчанию Python. Virtualenv позволяет создавать «виртуальную» среду с собственной копией Python и Virgin Set из библиотек. Почему вы хотите сделать это? Потому что это делает эксперименты с пакетами намного проще. Вы можете скачать и попробовать все, что вам нравится, не вызывая основную установку, и если вы обнаружите, что вам не нравится пакет, вы просто удалите папку, которая содержит виртуальную среду. SetUpeWools нужен для easy_install Цели, что является чем-то, что турбогиг много использует.

После того, как у вас есть этот загруженные и установленные вещи, откройте командный окно (или оболочку) и перейдите в место, где вы хотите создать виртуальную среду. Затем введите следующее, где «ПримерыFolder» – это имя папки, в которой вы хотите создать виртуальную среду.

Virtualenv – Nno-сайт-пакеты Примеры для примера

Флаг «-Но-сайт-пакетов» рассказывает Virtualenv, который вы не хотите копировать все свои пакеты на сайте из вашей главной установки Python. Я рекомендую это, поскольку у меня есть много вещей на моих сайтах-пакетах, которые я не хочу в моем виртуалене.

Далее вам нужно Сфинкс И вы не можете просто использовать текущую версию 0.6.2, так как она не работает прямо с TG2 (по состоянию на 07/16/2009). Вместо этого вам понадобится 0,6,2+, что вы можете получить здесь Отказ Для загрузки источника от BitBucket вам понадобится Mercurial Отказ Я рекомендую получить версию командной строки в качестве GUI, имел тенденцию к диалогам открытия файлов в моем окне Windows, из-за того, как Mercurial Dice Shell Overaves (он также прикрутил IDE Wingware). Это может быть исправлено сейчас. Как только у вас Mercurial, следуйте инструкциям «HG Clone» на сайте, связанном выше. Затем измените каталоги до тех пор, пока вы внутри источника и запустите «Установить Python Setup.py Установить» для установки SPHINX.

Следующий шаг – получить документы сами. У вас есть два варианта. Вы можете пойти с теми на главном веб-сайте TG2, или вы можете получить Mpedersen набор Отказ Точно так, что вы знаете, Mpedersen – это ручка IRC парень, который вызвался вести усилия в уборке документации. Единственное отличие состоит в том, что его набор будет иметь исправления уже в нем вместе с списком Todo на каждой странице. Я рекомендую его, чтобы дублирование усилий будет как минимум. Вы используете один и тот же «CH HG Clone», как вы сделали для взломанного источника SPHINX на последнем шаге.

Далее на последний шаг – это загрузить источник TG2-DEV и установить его. Вот команда Mercurial, чтобы получить источник:

HG Clone http://bitbucket.org/mramm/tg-21/

Теперь просто установите его, как вы сделали с SPHINX выше. Обратите внимание, что код DEF зависит от SQLALCHEMY и не устанавливает его автоматически, поэтому будьте также наверняка для Easy_install.

Мы почти там сейчас. Последний шаг – построить документы. Чтобы сделать это, перейдите в подпумну «Документы», которые вы загрузили и запустите следующую команду (или если вы находитесь в Linux, используйте «Сделайте HTML»):

Sphinx-Build -b HTML -D _Build/Doctryes. _build/html.

Теперь вы можете просматривать HTML-версии документов! Помните, чтобы редактировать документы, вы должны редактировать файлы RST, а не HTML. Когда вы готовы внести их обратно, вы будете использовать команду «HG Push». Я не сделал эту часть, поэтому ударил Mpedersen на канале IRC Turbogears для получения дополнительной информации.

Чтобы повторить, вот короткий список того, что вам нужно сделать:

1) Создайте чистый VirtualenV и активируйте его 2) Скачать SPHINX 0.6.2+ из https://bitbucket.org/birkenfeld/sphinx-06/ 3) Получите документы с главного сайта или от Mpedersen 4) Источник Dev зависит от SQLALCHEMY, поэтому Easy_install, что 5) Получите TG2-DEV Источник и установить его 6) Перейдите в загруженные подпапки TG2 Docs и запустите “Sphinx-build -b html -d _build/doctryes. _Build/HTML” (без кавычек) 7) И вы закончили!