update doc

skeeks-cms · Jul 6, 2017 · 101e54f · 101e54f
1 parent 7386f3c
commit 101e54f
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -128,3 +128,23 @@ FAQ
 
 
 
+Работа с документацией
+======================
+
+Для написания документации
+Временный раздел. Полезные команды для работы с документацией.
+
+.. code-block:: bash
+
+    apt-get install python-pip
+    pip install Sphinx
+    pip install sphinx-intl
+    pip install sphinx_rtd_theme
+
+    make gettext
+    make html
+    sphinx-intl update -p _build/gettext -l ru
+    #make -e SPHINXOPTS="-D language='ru'" html
+
+    sphinx-build -D language='ru' ./ build/ru
+    sphinx-build ./ build/en
diff --git a/docs/overview.rst b/docs/overview.rst
@@ -307,7 +307,10 @@ be deployed as soon as possible.
 Work with documents
 ===================
 
-This section is here temporarily
+Для написания документации используется генератор документации `Sphinx <http://sphinx-ru.readthedocs.io/ru/latest/>`_
+`Стандартный синтаксис разметки reStructuredText <http://sphinx-ru.readthedocs.io/ru/latest/rst-markup.html>`_
+
+Полезные команды для генерации:
 
 .. code-block:: bash
 
@@ -316,7 +319,6 @@ This section is here temporarily
     pip install sphinx-intl
     pip install sphinx_rtd_theme
 
-
     make gettext
     make html
     sphinx-intl update -p _build/gettext -l ru