Enhance docs

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -10,7 +10,7 @@ body:
           required: true
         - label: I have searched in the issue tracker for similar bug reports, including closed ones
           required: true
-        - label: I ran `pip3 install -U https://github.com/Mayuri-Chan/pyrofork/archive/master.zip` and reproduced the issue using the latest development version
+        - label: I ran `pip3 install -U https://github.com/eyMarv/pyrofork/archive/main.zip` and reproduced the issue using the latest development version
           required: true
 
   - type: textarea

README.md

@@ -1,6 +1,6 @@
 <p align="center">
-    <a href="https://github.com/Mayuri-Chan/pyrofok">
-        <img src="https://docs.pyrogram.org/_static/pyrogram.png" alt="Pyrofork" width="128">
+    <a href="https://github.com/eyMarv/pyrofork">
+        <img src="static/img/pyrofork.png" alt="Pyrofork" width="128">
     </a>
     <br>
     <b>Telegram MTProto API Framework for Python</b>
@@ -9,7 +9,7 @@
         Documentation
     </a>
     •
-    <a href="https://github.com/Mayuri-Chan/pyrofork/issues">
+    <a href="https://github.com/eyMarv/pyrofork/issues">
         Issues
     </a>
     •

build-docs.sh

@@ -10,22 +10,22 @@ make api
 cd compiler/docs && "$VENV"/bin/python compiler.py
 cd ../..
 "$VENV"/bin/sphinx-build -b html "docs/source" "docs/build/html" -j auto
-git clone https://wulan17:"$DOCS_KEY"@github.com/Mayuri-Chan/pyrofork-docs.git
+git clone https://eyMarv:"$DOCS_KEY"@github.com/eyMarv/pyrofork-docs.git
 cd pyrofork-docs
 refs=$(echo "$GITHUB_REF" | cut -d '/' -f "1 2") 
 if [[ "$refs" == "refs/tags" ]]; then
     mkdir -p main
     cd main
-    rm -rf _includes api genindex.html intro py-modindex.html sitemap.xml support.html topics _static faq index.html objects.inv searchindex.js start telegram
+    rm -rf _includes api genindex.html intro py-modindex.html sitemap.xml support.html topics static faq index.html objects.inv searchindex.js start telegram
     cp -r ../../docs/build/html/* .
 else
     mkdir -p staging
     cd staging
-    rm -rf _includes api genindex.html intro py-modindex.html sitemap.xml support.html topics _static faq index.html objects.inv searchindex.js start telegram
+    rm -rf _includes api genindex.html intro py-modindex.html sitemap.xml support.html topics static faq index.html objects.inv searchindex.js start telegram
     cp -r ../../docs/build/html/* .
 fi
-git config --local user.name "Mayuri-Chan"
-git config --local user.email "mayuri@mayuri.my.id"
+git config --local user.name "eyMarv"
+git config --local user.email "eyMarv07@gmail.com"
 git add --all
 git commit -a -m "docs: $(echo $GITHUB_REF | cut -d '/' -f 3): Update docs $(date '+%Y-%m-%d | %H:%m:%S %p %Z')" --signoff
 git push -u origin --all

docs/source/_static/css/all.min.css

@@ -1 +0,0 @@
-@import url("https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.2/css/all.min.css");

docs/source/_static/css/custom.css

@@ -1,24 +0,0 @@
-body{
-    --color-green: darkgreen;
-    --color-red: darkred;
-}
-
-.usable-by {
-    border: 1px ;
-    border-radius: .2em;
-    padding: 2px 5px;
-    background-color: #1a1c1e;
-}
-
-a .pre{
-    color:lightgrey;
-}
-
-.md-main a {
-    text-decoration: underline;
-    color:lightgrey;
-}
-
-.md-sidebar a {
-    text-decoration: none;
-}

docs/source/conf.py

@@ -29,8 +29,8 @@ from pygments.styles.friendly import FriendlyStyle
 FriendlyStyle.background_color = "#f3f2f1"
 
 project = "Pyrofork"
-copyright = f"2022-present, Mayuri-Chan"
-author = "Mayuri-Chan"
+copyright = f"2023-present, eyMarv + Mayuri-Chan"
+author = "eyMarv + Mayuri-Chan"
 
 version = ".".join(__version__.split(".")[:-1])
 
@@ -57,13 +57,17 @@ html_copy_source = False
 napoleon_use_rtype = False
 napoleon_use_param = False
 
-pygments_style = "friendly"
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# Decides the language used for syntax highlighting of code blocks.
+highlight_language = "python3"
 
 copybutton_prompt_text = "$ "
 
 suppress_warnings = ["image.not_readable"]
 
-html_title = "Pyrofork Documentation"
+html_title = f"Pyrofork Documentation v{__version__}"
 html_theme = "sphinx_immaterial"
 html_static_path = ["../resources/static","_static"]
 html_show_sourcelink = True

docs/source/faq/why-is-the-api-key-needed-for-bots.rst

@@ -4,7 +4,7 @@ Why is the API key needed for bots?
 Requests against the official bot API endpoints are made via JSON/HTTP and are handled by an intermediate server
 application that implements the MTProto protocol and uses its own API key to communicate with the MTProto servers.
 
-.. figure:: //_static/img/mtproto-vs-bot-api.png
+.. figure:: //static/img/mtproto-vs-bot-api.png
     :align: center
 
 Using MTProto is the only way to communicate with the actual Telegram servers, and the main API requires developers to

docs/source/topics/mtproto-vs-botapi.rst

@@ -37,7 +37,7 @@ special accounts that are authorized via tokens instead of phone numbers. The Bo
 main Telegram API, but runs on an intermediate server application that in turn communicates with the actual Telegram
 servers using MTProto.
 
-.. figure:: //_static/img/mtproto-vs-bot-api.png
+.. figure:: //static/img/mtproto-vs-bot-api.png
     :align: center
 
 .. _Bot API: https://core.telegram.org/bots/api