📝 Fix docs

WhiteApfel · Jul 12, 2022 · 1010888 · 1010888
1 parent 99bf1be
commit 1010888
Show file tree

Hide file tree

Showing 25 changed files with 1,023 additions and 918 deletions.
diff --git a/docs/Types.rst b/docs/Types.rst
@@ -1,20 +1,20 @@
 Types
 =============================
 
-.. autoclass:: pyqiwip2p.p2p_types.Customer.QiwiCustomer
+.. autoclass:: pyqiwip2p.p2p_types.customer.QiwiCustomer
    :members:
 
 -----------------
 
-.. autoclass:: pyqiwip2p.p2p_types.Errors.QiwiError
+.. autoclass:: pyqiwip2p.p2p_types.errors.QiwiError
    :members:
 
 -----------------
 
-.. autoclass:: pyqiwip2p.p2p_types.QiwiDatetime.QiwiDatetime
+.. autoclass:: pyqiwip2p.p2p_types.qiwi_datetime.QiwiDatetime
    :members:
 
 -----------------
 
-.. autoclass:: pyqiwip2p.p2p_types.Responses.Bill
+.. autoclass:: pyqiwip2p.p2p_types.responses.Bill
    :members:
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 7417c51ab410bf868423f35830be2404
+config: afce2d67ccb796ffc7445cd054196eeb
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html
@@ -4,16 +4,16 @@
 <html lang="ru">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Обзор: исходный код модуля &#8212; документация PyQiwiP2P </title>
-    <link rel="stylesheet" href="../_static/classic.css" type="text/css" />
-    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
-    <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
     <script src="../_static/jquery.js"></script>
     <script src="../_static/underscore.js"></script>
+    <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
     <script src="../_static/doctools.js"></script>
-    <script src="../_static/language_data.js"></script>
     <script src="../_static/translations.js"></script>
 
     <link rel="index" title="Алфавитный указатель" href="../genindex.html" />
@@ -36,16 +36,13 @@ <h3>Навигация</h3>
           <div class="body" role="main">
 
   <h1>Все модули, в которых есть код</h1>
-<ul><li><a href="pyqiwip2p/QiwiP2P.html">pyqiwip2p.QiwiP2P</a></li>
+<ul><li><a href="pyqiwip2p/Qiwip2p.html">pyqiwip2p.Qiwip2p</a></li>
 <li><a href="pyqiwip2p/notify.html">pyqiwip2p.notify</a></li>
-<li><a href="pyqiwip2p/qiwi_types/Customer.html">pyqiwip2p.qiwi_types.Customer</a></li>
-<li><a href="pyqiwip2p/qiwi_types/Errors.html">pyqiwip2p.qiwi_types.Errors</a></li>
-<li><a href="pyqiwip2p/qiwi_types/QiwiDatetime.html">pyqiwip2p.qiwi_types.QiwiDatetime</a></li>
-<li><a href="pyqiwip2p/qiwi_types/Responses.html">pyqiwip2p.qiwi_types.Responses</a></li>
-<li><a href="pyqiwip2p/types/Customer.html">pyqiwip2p.types.Customer</a></li>
-<li><a href="pyqiwip2p/types/Errors.html">pyqiwip2p.types.Errors</a></li>
-<li><a href="pyqiwip2p/types/QiwiDatetime.html">pyqiwip2p.types.QiwiDatetime</a></li>
-<li><a href="pyqiwip2p/types/Responses.html">pyqiwip2p.types.Responses</a></li>
+<ul><li><a href="pyqiwip2p/notify/async_client.html">pyqiwip2p.notify.async_client</a></li>
+</ul><li><a href="pyqiwip2p/p2p_types/customer.html">pyqiwip2p.p2p_types.customer</a></li>
+<li><a href="pyqiwip2p/p2p_types/errors.html">pyqiwip2p.p2p_types.errors</a></li>
+<li><a href="pyqiwip2p/p2p_types/qiwi_datetime.html">pyqiwip2p.p2p_types.qiwi_datetime</a></li>
+<li><a href="pyqiwip2p/p2p_types/responses.html">pyqiwip2p.p2p_types.responses</a></li>
 </ul>
 
             <div class="clearer"></div>
@@ -58,12 +55,12 @@ <h1>Все модули, в которых есть код</h1>
   <h3 id="searchlabel">Быстрый поиск</h3>
     <div class="searchformwrapper">
     <form class="search" action="../search.html" method="get">
-      <input type="text" name="q" aria-labelledby="searchlabel" />
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Искать" />
     </form>
     </div>
 </div>
-<script>$('#searchbox').show(0);</script>
+<script>document.getElementById('searchbox').style.display = "block"</script>
         </div>
       </div>
       <div class="clearer"></div>
@@ -79,8 +76,8 @@ <h3>Навигация</h3>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2020, WhiteApfel.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.1.2.
+        &#169; Copyright 2020-2022, WhiteApfel.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.0.2.
     </div>
   </body>
 </html>
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -6,10 +6,38 @@
 Документация PyQiwiP2P приветствует тебя!
 =========================================
 
-Обёрточка для `API Qiwi P2P`_ на Python.
+Удобная обёрточка для `API Qiwi P2P`_ на Python.
 
 .. _`API Qiwi P2P`: https://developer.qiwi.com/ru/p2p-payments/#API
 
+Важное уведомление
+------------------
+
+С июня Qiwi начала блокировать кошельки, если пользователь открыл
+страницу оплаты "напрямую", тем самым не передав заголовок referer.
+
+**Это случается при открытии ссылки:**
+
+* из мессенджера
+* из смс
+* из письма
+* из адресной строки
+* из браузера с повышенным режимом приватности или расширениями для приватного просмотра
+
+Для обхода всех проблем, кроме последней (она не решается), к объекту
+``Bill`` был добавлен атрибут ``Bill.alt_url``, который предоставляет ссылку
+для перенаправления на страницу оплаты через специальную
+страницу-прокладу, добавляющую этот самый referer.
+
+Страница предоставлена мною, но её можно поднять на своём сервере
+с помощью docker-контейнера.
+
+* Исходники: `Github <https://github.com/WhiteApfel/pyQiwiP2P/tree/master/p2proxy>`_
+* Образ контейнера: ``ghcr.io/whiteapfel/pyqiwip2p:p2proxy``
+* Запуск: ``docker run -p 3600:3600 -d ghcr.io/whiteapfel/pyqiwip2p:p2proxy``
+* Свой домен в клиенте: ``p2p = AioQiwiP2P(PrivKey, alt="example.com")``
+
+
 Зависимости
 -----------