DjangoBB LoFi version

Полная версия: локальную документацию Django

Начало » Django » локальную документацию Django

romankrv

Ноя. 19, 2008 13:54:47

Пытаюсь сделать локальную документацию с помощью rst2html
скрипт:

#!/bin/sh

#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;

но вывордит следующие:

Generating html documentation
contents.txt
basename: invalid option -- 's'
Попробуйте `basename --help' для получения более подробного описания.
contents.txt:7: (ERROR/3) Unknown directive type "toctree".

.. toctree::
   :maxdepth: 2

   intro/index
   topics/index
   howto/index
   faq/index
   ref/index
   misc/index
   glossary
   releases/index
   internals/index

contents.txt:23: (ERROR/3) Unknown interpreted text role "ref".
contents.txt:24: (ERROR/3) Unknown interpreted text role "ref".
contents.txt:25: (ERROR/3) Unknown interpreted text role "ref".
contents.txt:33: (ERROR/3) Unknown directive type "toctree".

.. toctree::
   :maxdepth: 2

   obsolete/index
glossary.txt
basename: invalid option -- 's'
Попробуйте `basename --help' для получения более подробного описания.
glossary.txt:7: (ERROR/3) Unknown directive type "glossary".

.. glossary::

    field
        An attribute on a :term:`model`; a given field usually maps directly to
        a single database column.

        See :ref:`topics-db-models`.

    generic view
        A higher-order :term:`view` function that abstracts common idioms and patterns
        found in view development and abstracts them.

        See :ref:`ref-generic-views`.

    model
        Models store your application's data.

        See :ref:`topics-db-models`.

    MTV
        See :ref:`mtv`.

    MVC
        `Model-view-controller`__; a software pattern. Django :ref:`follows MVC
        to some extent <mtv>`.

        __ http://en.wikipedia.org/wiki/Model-view-controller

    project
        A Python package -- i.e. a directory of code -- that contains all the
        settings for an instance of Django. This would include database
        configuration, Django-specific options and application-specific
        settings.

    property
        Also known as "managed attributes", and a feature of Python since
        version 2.2. From `the property documentation`__:

            Properties are a neat way to implement attributes whose usage
            resembles attribute access, but whose implementation uses method
            calls. [...] You
            could only do this by overriding ``__getattr__`` and
            ``__setattr__``; but overriding ``__setattr__`` slows down all
            attribute assignments considerably, and overriding ``__getattr__``
            is always a bit tricky to get right. Properties let you do this
            painlessly, without having to override ``__getattr__`` or
            ``__setattr__``.

        __ http://www.python.org/download/releases/2.2/descrintro/#property

    queryset
        An object representing some set of rows to be fetched from the database.

        See :ref:`topics-db-queries`.

    slug
        A short label for something, containing only letters, numbers,
        underscores or hyphens. They're generally used in URLs. For
        example, in a typical blog entry URL:

        .. parsed-literal::

            http://www.djangoproject.com/weblog/2008/apr/12/**spring**/

        the last bit (``spring``) is the slug.

    template
        A chunk of text that separates the presentation of a document from its
        data.

        See :ref:`topics-templates`.

    view
        A function responsible for rending a page.
index.txt
basename: invalid option -- 's'
Попробуйте `basename --help' для получения более подробного описания.
index.txt:14: (ERROR/3) Unknown interpreted text role "ref".
index.txt:16: (ERROR/3) Unknown interpreted text role "ref".
index.txt:16: (ERROR/3) Unknown interpreted text role "ref".
index.txt:16: (ERROR/3) Unknown interpreted text role "ref".
index.txt:36: (ERROR/3) Unknown interpreted text role "ref".
index.txt:36: (ERROR/3) Unknown interpreted text role "ref".
index.txt:37: (ERROR/3) Unknown interpreted text role "ref".
index.txt:37: (ERROR/3) Unknown interpreted text role "ref".
index.txt:37: (ERROR/3) Unknown interpreted text role "ref".
index.txt:37: (ERROR/3) Unknown interpreted text role "ref".
index.txt:42: (ERROR/3) Unknown interpreted text role "ref".
index.txt:42: (ERROR/3) Unknown interpreted text role "ref".
index.txt:42: (ERROR/3) Unknown interpreted text role "ref".
index.txt:43: (ERROR/3) Unknown interpreted text role "ref".
index.txt:43: (ERROR/3) Unknown interpreted text role "ref".
index.txt:44: (ERROR/3) Unknown interpreted text role "ref".
index.txt:44: (ERROR/3) Unknown interpreted text role "ref".
index.txt:45: (ERROR/3) Unknown interpreted text role "ref".
index.txt:45: (ERROR/3) Unknown interpreted text role "ref".
index.txt:45: (ERROR/3) Unknown interpreted text role "ref".
index.txt:45: (ERROR/3) Unknown interpreted text role "ref".
index.txt:46: (ERROR/3) Unknown interpreted text role "ref".
index.txt:46: (ERROR/3) Unknown interpreted text role "ref".
index.txt:46: (ERROR/3) Unknown interpreted text role "ref".
index.txt:51: (ERROR/3) Unknown interpreted text role "ref".
index.txt:51: (ERROR/3) Unknown interpreted text role "ref".
index.txt:52: (ERROR/3) Unknown interpreted text role "ref".
index.txt:52: (ERROR/3) Unknown interpreted text role "ref".
index.txt:57: (ERROR/3) Unknown interpreted text role "ref".
index.txt:57: (ERROR/3) Unknown interpreted text role "ref".
index.txt:57: (ERROR/3) Unknown interpreted text role "ref".
index.txt:58: (ERROR/3) Unknown interpreted text role "ref".
index.txt:59: (ERROR/3) Unknown interpreted text role "ref".
index.txt:59: (ERROR/3) Unknown interpreted text role "ref".
index.txt:59: (ERROR/3) Unknown interpreted text role "ref".
index.txt:59: (ERROR/3) Unknown interpreted text role "ref".
index.txt:59: (ERROR/3) Unknown interpreted text role "ref".
index.txt:60: (ERROR/3) Unknown interpreted text role "ref".
index.txt:60: (ERROR/3) Unknown interpreted text role "ref".
index.txt:60: (ERROR/3) Unknown interpreted text role "ref".
index.txt:61: (ERROR/3) Unknown interpreted text role "ref".
index.txt:61: (ERROR/3) Unknown interpreted text role "ref".
index.txt:66: (ERROR/3) Unknown interpreted text role "ref".
index.txt:66: (ERROR/3) Unknown interpreted text role "ref".
index.txt:66: (ERROR/3) Unknown interpreted text role "ref".
index.txt:66: (ERROR/3) Unknown interpreted text role "ref".
index.txt:67: (ERROR/3) Unknown interpreted text role "ref".
index.txt:67: (ERROR/3) Unknown interpreted text role "ref".
index.txt:67: (ERROR/3) Unknown interpreted text role "ref".
index.txt:67: (ERROR/3) Unknown interpreted text role "ref".
index.txt:68: (ERROR/3) Unknown interpreted text role "ref".
index.txt:68: (ERROR/3) Unknown interpreted text role "ref".
index.txt:73: (ERROR/3) Unknown interpreted text role "ref".
index.txt:73: (ERROR/3) Unknown interpreted text role "ref".
index.txt:74: (ERROR/3) Unknown interpreted text role "ref".
index.txt:74: (ERROR/3) Unknown interpreted text role "ref".
index.txt:75: (ERROR/3) Unknown interpreted text role "ref".
index.txt:76: (ERROR/3) Unknown interpreted text role "ref".
index.txt:76: (ERROR/3) Unknown interpreted text role "ref".
index.txt:76: (ERROR/3) Unknown interpreted text role "ref".
index.txt:76: (ERROR/3) Unknown interpreted text role "ref".
index.txt:76: (ERROR/3) Unknown interpreted text role "ref".
index.txt:76: (ERROR/3) Unknown interpreted text role "ref".
index.txt:81: (ERROR/3) Unknown interpreted text role "ref".
index.txt:82: (ERROR/3) Unknown interpreted text role "ref".
index.txt:83: (ERROR/3) Unknown interpreted text role "ref".
index.txt:84: (ERROR/3) Unknown interpreted text role "ref".
index.txt:85: (ERROR/3) Unknown interpreted text role "ref".
index.txt:86: (ERROR/3) Unknown interpreted text role "ref".
index.txt:87: (ERROR/3) Unknown interpreted text role "ref".
index.txt:88: (ERROR/3) Unknown interpreted text role "ref".
index.txt:89: (ERROR/3) Unknown interpreted text role "ref".
index.txt:90: (ERROR/3) Unknown interpreted text role "ref".
index.txt:91: (ERROR/3) Unknown interpreted text role "ref".
index.txt:92: (ERROR/3) Unknown interpreted text role "ref".
index.txt:93: (ERROR/3) Unknown interpreted text role "ref".
index.txt:94: (ERROR/3) Unknown interpreted text role "ref".
index.txt:95: (ERROR/3) Unknown interpreted text role "ref".
index.txt:96: (ERROR/3) Unknown interpreted text role "ref".
index.txt:97: (ERROR/3) Unknown interpreted text role "ref".
index.txt:98: (ERROR/3) Unknown interpreted text role "ref".
index.txt:99: (ERROR/3) Unknown interpreted text role "ref".
index.txt:100: (ERROR/3) Unknown interpreted text role "ref".
index.txt:101: (ERROR/3) Unknown interpreted text role "ref".
index.txt:102: (ERROR/3) Unknown interpreted text role "ref".
index.txt:103: (ERROR/3) Unknown interpreted text role "ref".
index.txt:108: (ERROR/3) Unknown interpreted text role "ref".
index.txt:108: (ERROR/3) Unknown interpreted text role "ref".
index.txt:108: (ERROR/3) Unknown interpreted text role "ref".
index.txt:109: (ERROR/3) Unknown interpreted text role "ref".
index.txt:110: (ERROR/3) Unknown interpreted text role "ref".
index.txt:111: (ERROR/3) Unknown interpreted text role "ref".
index.txt:112: (ERROR/3) Unknown interpreted text role "ref".
index.txt:112: (ERROR/3) Unknown interpreted text role "ref".

Где моя ошибка?

Спасибо

Александр Кошелев

Ноя. 19, 2008 15:14:03

$ cd django-trunk/docs
$ make html

slivlen

Ноя. 19, 2008 15:37:18

Перед тем как выполнить ‘make html’ убедись что у тебя есть sphinx-build. Если нет, то:

ez_setup.py sphinx

romankrv

Ноя. 19, 2008 16:18:27

Ага точно все заработало и собралось
кому интересно то сначала
так: sudo aptitude install python-sphinx
потом так : cd django-trunk/docs && make html
это кто в убунту дебиане :)