From 0dc953c32075d6a38ba945c1bd296f088b2695fd Mon Sep 17 00:00:00 2001
From: Dan <14043624+delivrance@users.noreply.github.com>
Date: Sun, 19 May 2019 21:40:41 +0200
Subject: [PATCH] Update domain name references to pyrogram.org
---
README.md | 8 ++---
docs/source/conf.py | 2 +-
docs/source/index.rst | 44 +++++++++++++++-----------
docs/source/sitemap.py | 2 +-
docs/source/topics/text-formatting.rst | 8 ++---
examples/bot_keyboards.py | 2 +-
examples/inline_queries.py | 8 ++---
examples/welcomebot.py | 2 +-
pyrogram/client/client.py | 4 +--
pyrogram/crypto/aes.py | 2 +-
setup.py | 6 ++--
11 files changed, 48 insertions(+), 40 deletions(-)
diff --git a/README.md b/README.md
index 6e12bce0..017b513b 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
Telegram MTProto API Framework for Python
-
+
Documentation
•
@@ -66,7 +66,7 @@ ground up in Python and C. It enables you to easily create custom apps for both
### Requirements
- Python 3.4 or higher.
-- A [Telegram API key](https://docs.pyrogram.ml/intro/setup#api-keys).
+- A [Telegram API key](https://docs.pyrogram.org/intro/setup#api-keys).
### Installing
@@ -76,11 +76,11 @@ pip3 install pyrogram
### Resources
-- The Docs contain lots of resources to help you getting started with Pyrogram: https://docs.pyrogram.ml.
+- The Docs contain lots of resources to help you getting started with Pyrogram: https://docs.pyrogram.org.
- Reading [Examples in this repository](https://github.com/pyrogram/pyrogram/tree/master/examples) is also a good way
for learning how Pyrogram works.
- Seeking extra help? Don't be shy, come join and ask our [Community](https://t.me/PyrogramChat)!
-- For other requests you can send an [Email](mailto:admin@pyrogram.ml) or a [Message](https://t.me/haskell).
+- For other requests you can send an [Email](mailto:dan@pyrogram.org) or a [Message](https://t.me/haskell).
### Contributing
diff --git a/docs/source/conf.py b/docs/source/conf.py
index e08298ef..5f073186 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -113,7 +113,7 @@ html_theme = 'sphinx_rtd_theme'
# documentation.
#
html_theme_options = {
- 'canonical_url': "https://docs.pyrogram.ml/",
+ 'canonical_url': "https://docs.pyrogram.org/",
'collapse_navigation': True,
'sticky_navigation': False,
'logo_only': True,
diff --git a/docs/source/index.rst b/docs/source/index.rst
index a68c81d9..89c92719 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -4,7 +4,7 @@ Welcome to Pyrogram
.. raw:: html
@@ -45,7 +45,7 @@ C. It enables you to easily create custom apps for both user and bot identities
`MTProto API`_.
.. _Telegram: https://telegram.org
-.. _MTProto API: topics/faq#what-can-mtproto-do-more-than-the-bot-api
+.. _MTProto API: topics/mtproto-vs-botapi#what-is-the-mtproto-api
How the Documentation is Organized
----------------------------------
@@ -62,7 +62,7 @@ First Steps
- `Handling Updates`_ - How to handle Telegram updates.
- `Error Handling`_ - How to handle API errors correctly.
-.. _Quick Start: intro/start
+.. _Quick Start: intro/quickstart
.. _Calling Methods: start/invoking
.. _Handling Updates: start/updates
.. _Error Handling: start/errors
@@ -80,26 +80,26 @@ API Reference
.. _Available Types: api/types
.. _Bound Methods: api/bound-methods
-Relevant Topics
-^^^^^^^^^^^^^^^
+Meta
+^^^^
-- `Smart Plugins`_ - How to modularize your application.
-- `Advanced Usage`_ - How to use Telegram's raw API.
-- `Release Notes`_ - Release notes for Pyrogram releases.
- `Pyrogram FAQ`_ - Answers to common Pyrogram questions.
- `Pyrogram Glossary`_ - A list of words with brief explanations.
+- `Release Notes`_ - Release notes for Pyrogram releases.
+- `Powered by Pyrogram`_ - A collection of Pyrogram Projects.
+- `Support Pyrogram Development`_ - Ways to show your appreciation.
-.. _Smart Plugins: topics/smart-plugins
-.. _Advanced Usage: topics/advanced-usage
-.. _Release Notes: topics/releases
-.. _Pyrogram FAQ: topics/faq
-.. _Pyrogram Glossary: topics/glossary
+.. _Pyrogram FAQ: meta/faq
+.. _Pyrogram Glossary: meta/glossary
+.. _Release Notes: meta/releases
+.. _Powered by Pyrogram: meta/powered-by
+.. _Support Pyrogram Development: meta/support-pyrogram
.. toctree::
:hidden:
:caption: Introduction
- intro/start
+ intro/quickstart
intro/install
intro/setup
@@ -107,7 +107,7 @@ Relevant Topics
:hidden:
:caption: Getting Started
- intro/auth
+ start/auth
start/invoking
start/updates
start/errors
@@ -139,12 +139,20 @@ Relevant Topics
topics/text-formatting
topics/proxy
topics/bots-interaction
+ topics/mtproto-vs-botapi
topics/test-servers
topics/advanced-usage
topics/voice-calls
- topics/releases
- topics/faq
- topics/glossary
+
+.. toctree::
+ :hidden:
+ :caption: Meta
+
+ meta/faq
+ meta/glossary
+ meta/releases
+ meta/powered-by
+ meta/support-pyrogram
.. toctree::
:hidden:
diff --git a/docs/source/sitemap.py b/docs/source/sitemap.py
index 539bac0d..b4d24c6a 100644
--- a/docs/source/sitemap.py
+++ b/docs/source/sitemap.py
@@ -20,7 +20,7 @@ import datetime
import os
import re
-canonical = "https://docs.pyrogram.ml"
+canonical = "https://docs.pyrogram.org/"
dirs = {
"start": ("weekly", 0.9),
diff --git a/docs/source/topics/text-formatting.rst b/docs/source/topics/text-formatting.rst
index 535fec31..8f2292d0 100644
--- a/docs/source/topics/text-formatting.rst
+++ b/docs/source/topics/text-formatting.rst
@@ -20,7 +20,7 @@ To use this mode, pass "markdown" in the *parse_mode* field when using
__italic text__
- [inline URL](https://docs.pyrogram.ml/)
+ [inline URL](https://docs.pyrogram.org/)
[inline mention of a user](tg://user?id=23122162)
@@ -43,7 +43,7 @@ The following tags are currently supported:
italic, italic
- inline URL
+ inline URL
inline mention of a user
@@ -66,7 +66,7 @@ Examples
"**bold**, "
"__italic__, "
"[mention](tg://user?id=23122162), "
- "[URL](https://docs.pyrogram.ml), "
+ "[URL](https://docs.pyrogram.org), "
"`code`, "
"```"
"for i in range(10):\n"
@@ -84,7 +84,7 @@ Examples
"bold, "
"italic, "
"mention, "
- "URL, "
+ "URL, "
"code, "
""
"for i in range(10):\n"
diff --git a/examples/bot_keyboards.py b/examples/bot_keyboards.py
index 4cbe8eaa..e1ff1e7e 100644
--- a/examples/bot_keyboards.py
+++ b/examples/bot_keyboards.py
@@ -39,7 +39,7 @@ with app:
),
InlineKeyboardButton( # Opens a web URL
"URL",
- url="https://docs.pyrogram.ml"
+ url="https://docs.pyrogram.org"
),
],
[ # Second row
diff --git a/examples/inline_queries.py b/examples/inline_queries.py
index c1727fe6..d86d90d5 100644
--- a/examples/inline_queries.py
+++ b/examples/inline_queries.py
@@ -22,12 +22,12 @@ def answer(client, inline_query):
input_message_content=InputTextMessageContent(
"Here's how to install **Pyrogram**"
),
- url="https://docs.pyrogram.ml/start/Installation",
+ url="https://docs.pyrogram.org/intro/install",
description="How to install Pyrogram",
thumb_url="https://i.imgur.com/JyxrStE.png",
reply_markup=InlineKeyboardMarkup(
[
- [InlineKeyboardButton("Open website", url="https://docs.pyrogram.ml/start/Installation")]
+ [InlineKeyboardButton("Open website", url="https://docs.pyrogram.org/intro/install")]
]
)
),
@@ -37,12 +37,12 @@ def answer(client, inline_query):
input_message_content=InputTextMessageContent(
"Here's how to use **Pyrogram**"
),
- url="https://docs.pyrogram.ml/start/Usage",
+ url="https://docs.pyrogram.org/start/invoking",
description="How to use Pyrogram",
thumb_url="https://i.imgur.com/JyxrStE.png",
reply_markup=InlineKeyboardMarkup(
[
- [InlineKeyboardButton("Open website", url="https://docs.pyrogram.ml/start/Usage")]
+ [InlineKeyboardButton("Open website", url="https://docs.pyrogram.org/start/invoking")]
]
)
)
diff --git a/examples/welcomebot.py b/examples/welcomebot.py
index ab252672..35f72aff 100644
--- a/examples/welcomebot.py
+++ b/examples/welcomebot.py
@@ -8,7 +8,7 @@ from pyrogram import Client, Emoji, Filters
TARGET = "PyrogramChat" # Target chat. Can also be a list of multiple chat ids/usernames
MENTION = "[{}](tg://user?id={})" # User mention markup
-MESSAGE = "{} Welcome to [Pyrogram](https://docs.pyrogram.ml/)'s group chat {}!" # Welcome message
+MESSAGE = "{} Welcome to [Pyrogram](https://docs.pyrogram.org/)'s group chat {}!" # Welcome message
app = Client("my_account")
diff --git a/pyrogram/client/client.py b/pyrogram/client/client.py
index 247a29cb..1cfa7c79 100644
--- a/pyrogram/client/client.py
+++ b/pyrogram/client/client.py
@@ -275,7 +275,7 @@ class Client(Methods, BaseClient):
log.warning('\nWARNING: You are using a bot token as session name!\n'
'This usage will be deprecated soon. Please use a session file name to load '
'an existing session and the bot_token argument to create new sessions.\n'
- 'More info: https://docs.pyrogram.ml/start/Setup#bot-authorization\n')
+ 'More info: https://docs.pyrogram.org/intro/auth#bot-authorization\n')
self.load_config()
self.load_session()
@@ -1091,7 +1091,7 @@ class Client(Methods, BaseClient):
else:
raise AttributeError(
"No API Key found. "
- "More info: https://docs.pyrogram.ml/intro/setup#configuration"
+ "More info: https://docs.pyrogram.org/intro/setup#configuration"
)
for option in ["app_version", "device_model", "system_version", "lang_code"]:
diff --git a/pyrogram/crypto/aes.py b/pyrogram/crypto/aes.py
index de275bd0..d603caa0 100644
--- a/pyrogram/crypto/aes.py
+++ b/pyrogram/crypto/aes.py
@@ -56,7 +56,7 @@ except ImportError:
log.warning(
"TgCrypto is missing! "
"Pyrogram will work the same, but at a much slower speed. "
- "More info: https://docs.pyrogram.ml/resources/TgCrypto"
+ "More info: https://docs.pyrogram.org/topics/tgcrypto"
)
diff --git a/setup.py b/setup.py
index 245655e6..f0d6d030 100644
--- a/setup.py
+++ b/setup.py
@@ -126,13 +126,13 @@ if len(argv) > 1 and argv[1] in ["bdist_wheel", "install", "develop"]:
setup(
name="Pyrogram",
version=version,
- description="Telegram MTProto API Client Library for Python",
+ description="Telegram MTProto API Client Library and Framework for Python",
long_description=readme,
long_description_content_type="text/markdown",
url="https://github.com/pyrogram",
download_url="https://github.com/pyrogram/pyrogram/releases/latest",
author="Dan Tès",
- author_email="admin@pyrogram.ml",
+ author_email="dan@pyrogram.org",
license="LGPLv3+",
classifiers=[
"Development Status :: 4 - Beta",
@@ -162,7 +162,7 @@ setup(
"Tracker": "https://github.com/pyrogram/pyrogram/issues",
"Community": "https://t.me/PyrogramChat",
"Source": "https://github.com/pyrogram/pyrogram",
- "Documentation": "https://docs.pyrogram.ml",
+ "Documentation": "https://docs.pyrogram.org",
},
python_requires="~=3.4",
packages=find_packages(exclude=["compiler*"]),
