Finish 0.3.30

the-tale · Nov 27, 2019 · 68b307d · 68b307d
2 parents 6a46e32 + 719b450
commit 68b307d
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,9 @@ pip install -r requirements.txt
 
 cd ./docs
 make html
-
-your-browser ./build/html/index.html
 ```
+
+#### Откройте документацию в браузере
+GNU/linux ``` $ xdg-open ./build/html/index.html```  
+macOS ```$ open ./build/html/index.html```  
+Windows - откройте `./build/html/index.html` в вашем браузере
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -35,7 +35,9 @@
               'sphinx.ext.todo',
               'sphinx.ext.mathjax',
               'sphinx.ext.ifconfig',
-              'sphinx.ext.viewcode']
+              'sphinx.ext.viewcode',
+              'sphinx_tabs.tabs',
+              ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -98,7 +100,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = []
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

diff --git a/docs/source/development/install.rst b/docs/source/development/install.rst
@@ -23,10 +23,24 @@
    mkdir ./the-tale-project
    cd ./the-tale-project
 
-   git clone https://github.com/Tiendil/the-tale.git
-   git clone https://github.com/Tiendil/deworld.git
-   git clone https://github.com/Tiendil/dext.git
-   git clone https://github.com/Tiendil/questgen.git
+.. tabs::
+
+   .. code-tab:: Bash Clone with HTTPS
+
+      git clone https://github.com/Tiendil/the-tale.git
+      git clone https://github.com/Tiendil/deworld.git
+      git clone https://github.com/Tiendil/dext.git
+      git clone https://github.com/Tiendil/questgen.git
+
+
+   .. code-tab:: Bash Clone with SSH
+
+      git clone git@github.com:the-tale/the-tale.git
+      git clone git@github.com:the-tale/deworld.git
+      git clone git@github.com:Tiendil/dext.git
+      git clone git@github.com:the-tale/questgen.git
+
+.. code-block:: bash
 
    # при необходимости переключаем репозитории в ветки develop
 
@@ -44,6 +58,7 @@
    ansible-galaxy install -r requirements.yml
 
    vagrant plugin install vagrant-hostmanager
+   vagrant plugin install vagrant-disksize
 
    # создаём виртуальную машину, запускаем и устанавливаем на неё всё необходимое
    # при первом запуске будет вызван vagrant provision

diff --git a/docs/source/external_api/methods.rst b/docs/source/external_api/methods.rst
@@ -231,7 +231,7 @@
 Информация о текущем ходе и герое
 
 :адрес: /game/api/info
-:http-метод: POST
+:http-метод: GET
 :версии: 1.9
 :параметры:
     * GET: account — идентификатор аккаунта
@@ -520,8 +520,6 @@
 :параметры: нет
 :ошибки: нет
 
-Метод является «неблокирующей операцией» (см. документацию), формат ответа соответствует ответу для всех «неблокирующих операций».
-
 При завершении операции возвращается дополнительная инфрмация:
 
 .. code-block:: javascript
@@ -550,7 +548,7 @@
 
 :адрес: /game/cards/api/combine
 :http-метод: POST
-:версии: 2.0
+:версии: 3.0
 :параметры:
     * POST: card — идентификатор карты, участвующей в трансформации, может быть несколько
 :ошибки:
@@ -562,7 +560,10 @@
 
     {
       "message": "строка",      // описание результата в формате html
-      "card": <card_info>       // описание полученной карты, формат см. в описании метода получения новой карты
+      "cards": [
+          <card_info>,     // описание полученной карты, формат см. в описании метода получения новой карты
+          …
+          ]
     }
 
 

diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,4 @@
 sphinx==1.6.5
 sphinx-autobuild==0.7.1
 sphinx-rtd-theme==0.2.4
+sphinx-tabs==1.1.11