Создание локальной копии документации Django

image

Да-да, это снова я и снова о документации Django :) На этот раз не будет длинных переводов, просто небольшая заметка.

Итак, если вы хотите всегда иметь доступ к документации по любимому средству разработки, этот топик для вас.


Linux:

  1. Запускаем командую строку и устанавливаем Sphinx:
    sudo easy_install Sphinx

  2. Внутри вашей директории с Django находим папку docs, заходим в нее и:
    make html

  3. Вот и все! Внутри docs выполняем:
    _build/html/index.html



Windows: (метод предоставил overPlumbum, за что ему «спасибо» :))

  1. Запускаем командную строку, переходим в папку Scripts из директории с Python и устанавливаем Sphinx:
    cd C:\Python26\Scripts
    easy_install sphinx

  2. Внутри вашей директории с Django находим папку docs, заходим в нее и создаем два новых раздела:
    cd C:\path_to_django_trunc\docs
    mkdir _build\html
    mkdir _build\doctrees

  3. С помощью установленного Sphinx создаем документацию:
    С:\Python26\Scripts\sphinx-build.exe -b html -d _build/doctrees. _build/html

  4. Ура! Теперь html-версия документации доступна здесь:
    C:\path_to_django_trunc\docs\_build\html\index.html


O чудо: теперь даже вдали от интернета вы можете ознакомиться с документацией :)
+18
12 января 2010, 11:32
24
fata1ex 101,9

комментарии (19)

0
Co0l3r #
а если windows?
+1
fata1ex #
А в чем проблемы? make, насколько я знаю, существует и для windows, убрать sudo, думаю, тоже не составит труда :)
+1
kmike #
sphinx, по идее, кладет файл make.bat (который делает то же, что и make+Makefile) в ту же папку, так что даже make для windows можно не ставить.

Правда сейчас глянул, у джанги этого файла нет)
0
overPlumbum #
точно можно, я собирал, и на каком-то форуме выкладывал инструкцию, напишу если вспомню где.
в принципе там ничего особо хитрого
+1
overPlumbum #
Инструкция по сборке под Windows: softwaremaniacs.org/forum/django/4683/
0
fata1ex #
С вашего позволения добавлю ссылку на инструкцию или саму инструкцию в пост
+1
overPlumbum #
пожалуйста
0
fata1ex #
Спасибо, добавил :)
+1
kmike #
Ну да, многие не знают про это почему-то.

С другой стороны, это стандартный и общепринятый способ распространения документации в питоне, и очень часто пакеты содержат точно такую же документацию. Сам питон, к примеру, большинство известных джанго-приложений (если не все) и тд. Это такая общепринятая штука в питоне, которая может быть новостью для людей, начавших свое обучение с django и знакомых с питоном не очень давно.

Кстати, писать документацию в sphinx — сплошное удовольствие.
+3
fata1ex #
Кстати, писать документацию в sphinx — сплошное удовольствие
Поделитесь статьёй на эту тему. Думаю, многим будет интересно ;)
+1
kmike #
Можно почитать первые четыре раздела из sphinx.pocoo.org/contents.html, потом еще sphinx.pocoo.org/ext/autodoc.html — и готово. А статьи от меня про sphinx не будет ;)

Кстати, в документации, которую генерит sphinx, есть один очень интересный момент, показавшийся сперва даже удивительным. Там есть поиск, который работает на чистом html+js. Т.е. он будет работать без интернет-соединения и без какой-бы то ни было серверной части.
+1
fata1ex #
Их документацию я уже просмотрел, на досуге надо будет его попробовать. А про статью жаль )
+1
spanasik #
Присоединяюсь.
+1
krylatij #
К слову, можно и в PDF. Как я понял, для этого конвертится сначала в latex, а потом уже в pdf
0
prefer #
Спасибо, работает!
Поясните пожалуйста, зачем это: _build/index.html? К тому же у меня там не оказалось index.html, этот файл лежит в _build/html/index.html
0
fata1ex #
Пожалуйста. И вам спасибо, досадная опечатка
+4
fata1ex #
«досадная опечатка» это не обращение :)
0
apkawa #
известное дело. Я даже собрал PKGBUILD для Arch Linux, который собирает документацию из svn/

aur.archlinux.org/packages.php?ID=32893
+1
anthonio #
for gentoo users:
    USE="doc" emerge -v django

;)

Только зарегистрированные пользователи могут оставлять комментарии. Войдите, пожалуйста.