Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Добавлена документация #65

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Добавлена документация #65

wants to merge 1 commit into from

Conversation

asyncee
Copy link

@asyncee asyncee commented Oct 13, 2016

Этот merge-request реализует документацию с использованием sphinx.

Что сделано:

  • создана директория docs
  • в неё перенесена существующая документация и разбита на разделы
  • создана базовая конфигурация sphinx

Как собрать документацию::

pip install sphinx                                                          
cd django-fias/docs                                                         
make dirhtml                                                                
cd build/dirhtml                                                            
python -m http.server 8000                                                  

Проследовать по адресу http://localhost:8000/                               

В качестве примера я взял документацию к своему проекту https://github.com/asyncee/django-easy-select2 и доработал её под django-fias.

Что рекомендуется сделать автору проекта:

  • сгенерировать документацию
  • внимательно просмотреть
  • структурировать и отредактировать по своему усмотрению
  • после этого влить изменения в проект и подключить сервис read the docs
    (easy-select2 собирается через него)

Что можно внести в планы:

  • документация существующего программного кода (докстринги)
  • настройка тестового проекта
  • конфигурация docs/conf.py для использования automodule (автогенерация
    документации по исходникам)
  • подключение соответствующих секций в index.rst или в sources.rst

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant