mirror of
https://github.com/elyby/docs.git
synced 2024-12-23 05:29:57 +05:30
Изменения, направленные на лучший опыт разработки:
- зависимости вынесены в requirements.txt - добавлена поддержка sphinx-autobuild - исправлено кодирование русских символов в файле конфигурации - мелкие правки шаблона
This commit is contained in:
parent
c81514c8c3
commit
4568bdd206
4
.gitignore
vendored
4
.gitignore
vendored
@ -1,5 +1,5 @@
|
||||
### My idea folder
|
||||
### .idea folder
|
||||
/.idea
|
||||
|
||||
### BUILD FOLDER
|
||||
/build
|
||||
/build
|
||||
|
3
Makefile
3
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
|
||||
|
36
README.md
Normal file
36
README.md
Normal file
@ -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 убедитесь, что в пути нет русских, белорусских, китайских или иных других символов, отличных от англисйкого
|
||||
алфавита.
|
4
make.bat
4
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
|
||||
|
3
requirements.txt
Normal file
3
requirements.txt
Normal file
@ -0,0 +1,3 @@
|
||||
Sphinx>=1.3.1
|
||||
sphinx-rtd-theme>=0.1.8
|
||||
sphinx-autobuild>=0.5.2
|
@ -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;
|
||||
}
|
||||
}
|
||||
|
||||
.wy-side-nav-search > a {
|
||||
font-size: 21px;
|
||||
}
|
||||
|
||||
.wy-nav-top {
|
||||
line-height: 30px;
|
||||
}
|
||||
|
@ -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
|
||||
# "<project> v<release> 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
|
||||
|
@ -9,7 +9,8 @@
|
||||
В этой документации вы найдёте информацию о публичных сервисах проекта Ely.by, ознакомившись с которой вы сможете самостоятельно
|
||||
реализовать свои программные продукты для совместной работы с сервисом Ely.by.
|
||||
|
||||
Вы можете свободно улучшать и вносить предложения по изменениям в документацию в репозитории документации.
|
||||
Вы можете свободно улучшать и вносить предложения по изменениям в документацию в
|
||||
`репозитории документации <https://bitbucket.org/ErickSkrauch/ely.by-docs>`_.
|
||||
|
||||
Содержание:
|
||||
~~~~~~~~~~~
|
||||
|
Loading…
Reference in New Issue
Block a user