PayTechUz · hoosnick · Aug 20, 2023 · Aug 20, 2023 · Aug 20, 2023 · Aug 20, 2023
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,16 @@
+name: Documentation
+
+on:
+ push:
+ branches:
+ - payme-pkg-3.0b
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions/setup-python@v2
+ with:
+ python-version: 3.x
+ - run: pip install -r requirements/docs-requirements.txt
+ - run: mkdocs gh-deploy --force
diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml
@@ -1,6 +1,12 @@
 name: Pylint
 
-on: [push, pull_request]
+on:
+ push:
+ paths-ignore:
+ - "docs/**"
+ pull_request:
+ paths-ignore:
+ - "docs/**"
 
 jobs:
  build:
@@ -17,7 +23,7 @@ jobs:
  - name: Install dependencies
  run: |
  python -m pip install --upgrade pip
- pip install -r requirements.txt
+ pip install -r requirements/requirements.txt
  pip install pylint
  - name: Analysing the code with pylint
  run: |

diff --git a/docs/src/assets/logo.png b/docs/src/assets/logo.png
diff --git a/docs/src/en/index.md b/docs/src/en/index.md
@@ -0,0 +1,65 @@
+---
+title: Introduction
+---
+
+# **Welcome!**
+
+### Uzbekistan Payment Providers Packages
+
+[<img align="right" alt="PayTechUz" height="280" width="280" src="https://github.com/PayTechUz/.github/assets/73847672/90e1c28a-f3ae-409a-8d8c-341b0fbe39e3" />](https://pay-tech.uz)
+
+Welcome to the PayTechUz organization! This project aims to provide developers with seamless integration and implementation of Payment Providers APIs in Uzbekistan. Whether you're a Python enthusiast or a Go guru, we've got you covered with our versatile tech stack.
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Website](#website)
+- [Telegram Group](#telegram-group)
+- [Tech Stack](#tech-stack)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [Support](#support)
+- [License](#license)
+
+## Introduction
+
+Integrating payment providers into your applications is crucial in today's digital landscape. This project simplifies the process of integrating Payment Providers APIs in Uzbekistan, allowing you to focus on building amazing products while leaving the payment processing worries behind.
+
+## Website
+
+Visit our website [pay-tech.uz](https://pay-tech.uz) to explore detailed documentation, guides, and API references. We regularly update the documentation to ensure you have the most up-to-date information at your disposal.
+
+## Telegram Group
+
+Join our vibrant developer community on Telegram to connect with fellow developers, ask questions, share experiences, and stay updated with the latest news and announcements.
+
+[Telegram Group](https://t.me/+krHlGUizJrI1Zjli)
+
+## Tech Stack
+
+We have carefully chosen the following tech stack to ensure flexibility and ease of use:
+
+- [![Python](https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white)](https://python.org/)
+- [![Go](https://img.shields.io/badge/Go-00ADD8?style=for-the-badge&logo=go&logoColor=white)](https://go.dev/)
+
+The combination of Python and Go offers a wide range of possibilities to cater to the preferences of different developers.
+
+## Usage
+
+Our packages are designed to streamline the integration process. Follow the detailed instructions in the documentation for each package to integrate the desired Payment Providers API seamlessly.
+
+## Contributing
+
+We welcome contributions from the community to make this project even better. If you find any issues or have suggestions for improvements, feel free to open an issue or submit a pull request. Please ensure you follow our [contribution guidelines](https://github.com/PayTechUz/.github/blob/main/profile/CONTRIBUTING.md).
+
+## Support
+
+If you encounter any problems, have questions, or need assistance with the integration, our team is here to help. Reach out to us on our [Telegram Group](https://t.me/+ydVV_9B3Xh02NGEy) or email us at [email protected].
+
+## License
+
+This project is licensed under the [MIT License](https://github.com/PayTechUz/.github/blob/main/profile/LICENSE.txt), making it open and free for everyone to use, modify, and distribute.
+
+---
+
+We hope our PayTechUz packages make your payment integration process a delightful experience. Happy coding!
diff --git a/docs/src/en/merchant-api.md b/docs/src/en/merchant-api.md
@@ -0,0 +1,6 @@
+---
+title: Merchant API methods
+description: Merchant API methods
+---
+
+# Merchant API methods
diff --git a/docs/src/en/sandbox.md b/docs/src/en/sandbox.md
@@ -0,0 +1,6 @@
+---
+title: Sandbox (Testing)
+description: Sandbox (Testing)
+---
+
+# Sandbox (Testing)
diff --git a/docs/src/en/setup.md b/docs/src/en/setup.md
@@ -0,0 +1,6 @@
+---
+title: Interaction setup
+description: Interaction setup
+---
+
+# Interaction setup
diff --git a/docs/src/en/subscribe-api.md b/docs/src/en/subscribe-api.md
@@ -0,0 +1,6 @@
+---
+title: Subscribe API methods
+description: Subscribe API methods
+---
+
+# Subscribe API methods
diff --git a/docs/src/en/support.md b/docs/src/en/support.md
@@ -0,0 +1,6 @@
+---
+title: Technical support
+description: Technical support
+---
+
+# Technical support
diff --git a/docs/src/overrides/partials/nav.html b/docs/src/overrides/partials/nav.html
@@ -0,0 +1,23 @@
+<nav
+ class="md-nav md-nav--primary"
+ aria-label="{{ lang.t('nav.title') }}"
+ data-md-level="0"
+>
+ <label class="md-nav__title" for="__drawer">
+ <a
+ href="{{ config.site_url | default(nav.homepage.url, true) | url }}"
+ title="{{ config.site_name }}"
+ class="md-nav__button md-logo"
+ aria-label="{{ config.site_name }}"
+ >
+ {% include "partials/logo.html" %}
+ </a>
+ </label>
+ {% if config.repo_url %}
+ <div class="md-nav__source">{% include "partials/source.html" %}</div>
+ {% endif %}
+ <ul class="md-nav__list" data-md-scrollfix>
+ {% for nav_item in nav %} {% set path = "nav-" + loop.index | string %} {%
+ set level = 1 %} {% include "partials/nav-item.html" %} {% endfor %}
+ </ul>
+</nav>
diff --git a/docs/src/ru/index.md b/docs/src/ru/index.md
@@ -0,0 +1,5 @@
+---
+title: Введение
+---
+
+# **Добро пожаловать!**
diff --git a/docs/src/ru/merchant-api.md b/docs/src/ru/merchant-api.md
@@ -0,0 +1,6 @@
+---
+title: Методы Merchant API
+description: Методы Merchant API
+---
+
+# Методы Merchant API
diff --git a/docs/src/ru/sandbox.md b/docs/src/ru/sandbox.md
@@ -0,0 +1,6 @@
+---
+title: Песочница (Тестирование)
+description: Песочница (Тестирование)
+---
+
+# Песочница (Тестирование)
diff --git a/docs/src/ru/setup.md b/docs/src/ru/setup.md
@@ -0,0 +1,6 @@
+---
+title: Настройка взаимодействия
+description: Настройка взаимодействия
+---
+
+# Настройка взаимодействия
diff --git a/docs/src/ru/subscribe-api.md b/docs/src/ru/subscribe-api.md
@@ -0,0 +1,6 @@
+---
+title: Методы Subscribe API
+description: Методы Subscribe API
+---
+
+# Методы Subscribe API
diff --git a/docs/src/ru/support.md b/docs/src/ru/support.md
@@ -0,0 +1,6 @@
+---
+title: Техническая поддержка
+description: Техническая поддержка
+---
+
+# Техническая поддержка
diff --git a/docs/src/uz/index.md b/docs/src/uz/index.md
@@ -0,0 +1,5 @@
+---
+title: Kirish
+---
+
+# **Xush kelibsiz!**
diff --git a/docs/src/uz/merchant-api.md b/docs/src/uz/merchant-api.md
@@ -0,0 +1,6 @@
+---
+title: Merchant API metodlari
+description: Merchant API metodlari
+---
+
+# Merchant API metodlari
diff --git a/docs/src/uz/sandbox.md b/docs/src/uz/sandbox.md
@@ -0,0 +1,6 @@
+---
+title: Qumdon (Sandbox)
+description: Qumdon (Sandbox)
+---
+
+# Qumdon (Sandbox)
diff --git a/docs/src/uz/setup.md b/docs/src/uz/setup.md
@@ -0,0 +1,6 @@
+---
+title: Sozlash (Setup)
+description: Sozlash (Setup)
+---
+
+# Sozlash (Setup)
diff --git a/docs/src/uz/subscribe-api.md b/docs/src/uz/subscribe-api.md
@@ -0,0 +1,6 @@
+---
+title: Subscribe API metodlari
+description: Subscribe API metodlari
+---
+
+# Subscribe API metodlari
diff --git a/docs/src/uz/support.md b/docs/src/uz/support.md
@@ -0,0 +1,6 @@
+---
+title: Texnik yordam
+description: Texnik yordam
+---
+
+# Texnik yordam
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,111 @@
+# Project information
+site_name: "Documentation 'payme-pkg'"
+site_description: 🟢 Merchant Api and Subscribe Api Integration 2023—08
+site_author: Hoosnick
+site_url: https://paytechuz.github.io/payme-pkg
+docs_dir: docs/src
+site_dir: payme
+
+# Repository
+repo_name: PayTechUz/payme-pkg
+repo_url: https://github.com/PayTechUz/payme-pkg
+edit_uri: ""
+
+# Copyright
+copyright: Copyright &copy; 2023 PayTechUz
+
+# Configuration
+theme:
+ name: material
+ custom_dir: docs/src/overrides
+ language: en
+ palette:
+ - media: "(prefers-color-scheme: light)"
+ scheme: default
+ primary: teal
+ toggle:
+ icon: material/brightness-4
+ name: Switch to dark mode
+ - media: "(prefers-color-scheme: dark)"
+ scheme: slate
+ primary: teal
+ toggle:
+ icon: material/brightness-7
+ name: Switch to light mode
+ font:
+ text: Ubuntu
+ code: Roboto Mono
+ icon:
+ logo: material/cash-multiple
+ # logo: assets/logo.png
+
+# Extras
+extra:
+ social:
+ - icon: fontawesome/brands/telegram
+ link: https://t.me/+7Gn-JZ99TfgwZDNi
+ name: "Biz telegramda"
+ - icon: fontawesome/brands/github-alt
+ link: https://github.com/PayTechUz/payme-pkg
+ name: GitHub
+
+# Extensions
+markdown_extensions:
+ - admonition
+ - pymdownx.highlight
+ - pymdownx.superfences
+ - pymdownx.details
+ - meta
+ - attr_list
+ - toc:
+ permalink: true
+
+nav:
+ - "home": index.md
+ - "interaction_setup": setup.md
+ - "merchant_api": merchant-api.md
+ - "subscribe_api": subscribe-api.md
+ - "sandbox": sandbox.md
+ - "support": support.md
+
+plugins:
+ - search
+ - i18n:
+ default_language: en
+ default_language_only: false
+ docs_structure: folder
+
+ languages:
+ en:
+ name: "<img style='height: 10px; border: 0px;'' alt='en' src='https://flagicons.lipis.dev/flags/4x3/us.svg' title='english' /> English"
+ build: true
+ uz:
+ name: "<img style='height: 10px; border: 0px;' alt='uz' src='https://flagicons.lipis.dev/flags/4x3/uz.svg' title='uzbek' /> O'zbekcha"
+ build: true
+ ru:
+ name: "<img style='height: 10px; border: 0px;'' alt='ru' src='https://flagicons.lipis.dev/flags/4x3/ru.svg' title='russian' /> Русский"
+ build: true
+ site_name: "Документация 'payme-pkg'"
+
+ nav_translations:
+ en:
+ "home": "Introduction"
+ "interaction_setup": "Interaction setup"
+ "merchant_api": "Merchant API"
+ "subscribe_api": "Subscribe API"
+ "sandbox": "Sandbox (Testing)"
+ "support": "Technical support"
+ ru:
+ "home": "Введение"
+ "interaction_setup": "Настройка взаимодействия"
+ "merchant_api": "Merchant API"
+ "subscribe_api": "Subscribe API"
+ "sandbox": "Песочница (Тестирование)"
+ "support": "Техническая поддержка"
+ uz:
+ "home": "Kirish"
+ "interaction_setup": "Sozlash (Setup)"
+ "merchant_api": "Merchant API"
+ "subscribe_api": "Subscribe API"
+ "sandbox": "Qumdon (Sandbox)"
+ "support": "Texnik yordam"
diff --git a/requirements/docs-requirements.txt b/requirements/docs-requirements.txt
@@ -0,0 +1,2 @@
+mkdocs-material==9.1.21
+mkdocs-static-i18n==0.56
diff --git a/requirements.txt → requirements/requirements.txt b/requirements.txt → requirements/requirements.txt