Добрй день!
Может мне кто нибудь объяснить как по человечески документировать свой код?
Мне нужно чтоб он тупо взял мою функцию из файла, прочитал там соотвествующие каменты в """comments""" и сделал по ним доку в html. Все!
есть у меня файл user.rst:
************
Пользователь
************
UserInfo
========
GET UserInfo
------------
.. autofunction:: mainapp.views.userinfo_views.userInfo_GET
EDIT UserInfo
-------------
.. autofunction:: mainapp.views.userinfo_views.userInfo_POST
Photoalbums GET ALL
===================
.. autofunction:: mainapp.views.userinfo_views.photoalbums_GET_EVERYTHING
есть файл index.rst:
Welcome to documentation!
================================
Contents:
.. toctree::
:maxdepth: 2
authentification.rst
user.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
После того как я делаю make html мне вываливается куча ошибок!
например
/home/ubuntu/my_second_env/amic/docs/source/user.rst:11: WARNING: autodoc: failed to import function u'userInfo_GET' from module u'mainapp.views.userinfo_views'; the following exception was raised:
Traceback (most recent call last):
File "/home/ubuntu/my_second_env/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 385, in import_object
__import__(self.modname)
File "/home/ubuntu/my_second_env/amic/mainapp/views/userinfo_views.py", line 15, in <module>
from guardian.models import UserObjectPermission
File "/home/ubuntu/my_second_env/local/lib/python2.7/site-packages/guardian/models.py", line 18, in <module>
from guardian.conf import settings
File "/home/ubuntu/my_second_env/local/lib/python2.7/site-packages/guardian/conf/settings.py", line 11, in <module>
raise ImproperlyConfigured("In order to use django-guardian's "
ImproperlyConfigured: In order to use django-guardian's ObjectPermissionBackend authorization backend you have to configure ANONYMOUS_USER_ID at your settings module
Тогда я вставил в conf.py следующее(это мой сеттингс):
from django.conf import settings
from amic import settings as S1
settings.configure(S1)
Теперь ошибки такие:
/home/ubuntu/my_second_env/amic/docs/source/user.rst:11: WARNING: autodoc: failed to import function u'userInfo_GET' from module u'mainapp.views.userinfo_views'; the following exception was raised:
Traceback (most recent call last):
File "/home/ubuntu/my_second_env/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 385, in import_object
__import__(self.modname)
File "/home/ubuntu/my_second_env/amic/mainapp/views/userinfo_views.py", line 10, in <module>
from django.contrib.auth.models import User, Permission
File "/home/ubuntu/my_second_env/local/lib/python2.7/site-packages/django/contrib/auth/__init__.py", line 7, in <module>
from django.middleware.csrf import rotate_token
File "/home/ubuntu/my_second_env/local/lib/python2.7/site-packages/django/middleware/csrf.py", line 14, in <module>
from django.utils.cache import patch_vary_headers
File "/home/ubuntu/my_second_env/local/lib/python2.7/site-packages/django/utils/cache.py", line 26, in <module>
from django.core.cache import caches
File "/home/ubuntu/my_second_env/local/lib/python2.7/site-packages/django/core/cache/__init__.py", line 34, in <module>
if DEFAULT_CACHE_ALIAS not in settings.CACHES:
File "/home/ubuntu/my_second_env/local/lib/python2.7/site-packages/django/conf/__init__.py", line 49, in __getattr__
return getattr(self._wrapped, name)
File "/home/ubuntu/my_second_env/local/lib/python2.7/site-packages/django/conf/__init__.py", line 160, in __getattr__
return getattr(self.default_settings, name)
AttributeError: 'module' object has no attribute 'CACHES'
Кто нить может объяснить как этот Сфинкс использовать в Джанго проекте? Чтоб он тупо смотрел мою функцию и никуда больше не лез.
Обновлено 21 Июнь 2015, 16:09 Closius.
