From 4568bdd206cc6cc5f08d3aeacf6beec3f01c2d1b Mon Sep 17 00:00:00 2001 From: ErickSkrauch Date: Sun, 23 Aug 2015 20:03:58 +0300 Subject: [PATCH] =?UTF-8?q?=D0=98=D0=B7=D0=BC=D0=B5=D0=BD=D0=B5=D0=BD?= =?UTF-8?q?=D0=B8=D1=8F,=20=D0=BD=D0=B0=D0=BF=D1=80=D0=B0=D0=B2=D0=BB?= =?UTF-8?q?=D0=B5=D0=BD=D0=BD=D1=8B=D0=B5=20=D0=BD=D0=B0=20=D0=BB=D1=83?= =?UTF-8?q?=D1=87=D1=88=D0=B8=D0=B9=20=D0=BE=D0=BF=D1=8B=D1=82=20=D1=80?= =?UTF-8?q?=D0=B0=D0=B7=D1=80=D0=B0=D0=B1=D0=BE=D1=82=D0=BA=D0=B8:=20-=20?= =?UTF-8?q?=D0=B7=D0=B0=D0=B2=D0=B8=D1=81=D0=B8=D0=BC=D0=BE=D1=81=D1=82?= =?UTF-8?q?=D0=B8=20=D0=B2=D1=8B=D0=BD=D0=B5=D1=81=D0=B5=D0=BD=D1=8B=20?= =?UTF-8?q?=D0=B2=20requirements.txt=20-=20=D0=B4=D0=BE=D0=B1=D0=B0=D0=B2?= =?UTF-8?q?=D0=BB=D0=B5=D0=BD=D0=B0=20=D0=BF=D0=BE=D0=B4=D0=B4=D0=B5=D1=80?= =?UTF-8?q?=D0=B6=D0=BA=D0=B0=20sphinx-autobuild=20-=20=D0=B8=D1=81=D0=BF?= =?UTF-8?q?=D1=80=D0=B0=D0=B2=D0=BB=D0=B5=D0=BD=D0=BE=20=D0=BA=D0=BE=D0=B4?= =?UTF-8?q?=D0=B8=D1=80=D0=BE=D0=B2=D0=B0=D0=BD=D0=B8=D0=B5=20=D1=80=D1=83?= =?UTF-8?q?=D1=81=D1=81=D0=BA=D0=B8=D1=85=20=D1=81=D0=B8=D0=BC=D0=B2=D0=BE?= =?UTF-8?q?=D0=BB=D0=BE=D0=B2=20=D0=B2=20=D1=84=D0=B0=D0=B9=D0=BB=D0=B5=20?= =?UTF-8?q?=D0=BA=D0=BE=D0=BD=D1=84=D0=B8=D0=B3=D1=83=D1=80=D0=B0=D1=86?= =?UTF-8?q?=D0=B8=D0=B8=20-=20=D0=BC=D0=B5=D0=BB=D0=BA=D0=B8=D0=B5=20?= =?UTF-8?q?=D0=BF=D1=80=D0=B0=D0=B2=D0=BA=D0=B8=20=D1=88=D0=B0=D0=B1=D0=BB?= =?UTF-8?q?=D0=BE=D0=BD=D0=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 4 ++-- Makefile | 3 +++ README.md | 36 ++++++++++++++++++++++++++++++++++++ make.bat | 4 ++++ requirements.txt | 3 +++ source/_static/style.css | 13 +++++++++++-- source/conf.py | 4 ++-- source/index.rst | 3 ++- 8 files changed, 63 insertions(+), 7 deletions(-) create mode 100644 README.md create mode 100644 requirements.txt diff --git a/.gitignore b/.gitignore index 7c0848f..940eff6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ -### My idea folder +### .idea folder /.idea ### BUILD FOLDER -/build \ No newline at end of file +/build diff --git a/Makefile b/Makefile index 97f472f..a4ab7d0 100644 --- a/Makefile +++ b/Makefile @@ -54,6 +54,9 @@ html: @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." +livehtml: + sphinx-autobuild -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo diff --git a/README.md b/README.md new file mode 100644 index 0000000..9cce333 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Документация Ely.by + +В этом репозитории находятся исходные файлы [сайта документации](http://docs.ely.by) проекта [Ely.by](http://ely.by) + +В этой документации вы найдёте информацию о публичных сервисах проекта Ely.by, ознакомившись с которой вы сможете +самостоятельно реализовать свои программные продукты для совместной работы с сервисом Ely.by. + +**Вы можете свободно улучшать и вносить предложения по изменениям в документацию.** + +# Установка зависимостей + +Для ведения документации мы используем [генератор документации Sphinx](http://sphinx-doc.org/) и тему +[Read the Docs Sphinx Theme](https://github.com/snide/sphinx_rtd_theme) с небольшими доработками под стиль сайта. + +Для компиляции вам понадобится установленный Python 2.7 (теоретически будет работать и на 3.4, но мы не проверяли) и +менеджер зависимостей pip. Убедитесь, что они доступны глобально. + +Для начала форкните и склонируйте этот репозиторий к себе на компьютер. За тем установите зависимости. Для этого +находясь в папке проекта откройте консоль и выполните: + +``` +pip install -r requirements.txt +``` + +# Компиляция и разработка + +После установки необходимых зависимостей вам необходимо запустить непосредственно процесс компиляции. Вы можете вручную +настроить свой веб-сервер для работы со скомпилированными шаблонами, скомпилировав их командой ```make html``` или же +воспользуйтесь командой ```make livehtml``` для запуска локальное веб-сервера и автоматической рекомпиляции шаблонов, +при их изменении. Сайт станет доступен по адресу ```127.0.0.1:8000```. + +# Примечание + +На операционных системах Windows Python не очень любит неанглийские символы в пути к файлам, так что при разработке под +Windows убедитесь, что в пути нет русских, белорусских, китайских или иных других символов, отличных от англисйкого +алфавита. diff --git a/make.bat b/make.bat index e051d71..610fefc 100644 --- a/make.bat +++ b/make.bat @@ -68,6 +68,10 @@ if "%1" == "html" ( goto end ) +if "%1" == "livehtml" ( + sphinx-autobuild -b html %ALLSPHINXOPTS% %BUILDDIR%/html +) + if "%1" == "dirhtml" ( %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml if errorlevel 1 exit /b 1 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..d5d69f1 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +Sphinx>=1.3.1 +sphinx-rtd-theme>=0.1.8 +sphinx-autobuild>=0.5.2 diff --git a/source/_static/style.css b/source/_static/style.css index 5feaa7a..4100bbb 100644 --- a/source/_static/style.css +++ b/source/_static/style.css @@ -4,7 +4,7 @@ body { background: #ebe8e1!important; } -h1, h2, h3, h4, h5, h6, legend { +h1, h2, h3, h4, h5, h6, legend, .wy-side-nav-search > a, .wy-nav-top a { font-family: "Roboto Condensed", "Roboto Slab", sans-serif; font-weight: normal; } @@ -20,9 +20,18 @@ h1, h2, h3, h4, h5, h6, legend { .wy-nav-side { background-color: #232323; + overflow-y: auto; } .wy-table-responsive table td, .wy-table-responsive table th { white-space: normal; -} \ No newline at end of file +} + +.wy-side-nav-search > a { + font-size: 21px; +} + +.wy-nav-top { + line-height: 30px; +} diff --git a/source/conf.py b/source/conf.py index 0f77cd8..aee0bd0 100644 --- a/source/conf.py +++ b/source/conf.py @@ -45,7 +45,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = 'Документация Ely.by' +project = unicode('Документация Ely.by', "utf-8" ) copyright = '2015, ErickSkrauch' # The version info for the project you're documenting, acts as replacement for @@ -112,7 +112,7 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +html_title = unicode('Документация Ely.by v' + release, 'utf-8') # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None diff --git a/source/index.rst b/source/index.rst index a76cfc4..f956f77 100644 --- a/source/index.rst +++ b/source/index.rst @@ -9,7 +9,8 @@ В этой документации вы найдёте информацию о публичных сервисах проекта Ely.by, ознакомившись с которой вы сможете самостоятельно реализовать свои программные продукты для совместной работы с сервисом Ely.by. -Вы можете свободно улучшать и вносить предложения по изменениям в документацию в репозитории документации. +Вы можете свободно улучшать и вносить предложения по изменениям в документацию в +`репозитории документации `_. Содержание: ~~~~~~~~~~~