doc: add icons, add community page, add links to Rustilka & MeowUI

and3rson · Apr 15, 2024 · 0836a4f · 0836a4f
1 parent 13c2eff
commit 0836a4f
Show file tree

Hide file tree

Showing 13 changed files with 89 additions and 31 deletions.
diff --git a/docs/_static/extra_style.css b/docs/_static/extra_style.css
diff --git a/docs/about/index.rst b/docs/about/index.rst
@@ -1,5 +1,5 @@
-Про проєкт
-==========
+:octicon:`package` Про проєкт
+=============================
 
 .. include:: what_is_lilka.rst
 

diff --git a/docs/assembly/index.rst b/docs/assembly/index.rst
@@ -1,5 +1,5 @@
-Як зібрати Лілку
-================
+:octicon:`tools` Як зібрати Лілку
+=================================
 
 .. warning:: Ця документація знаходиться в розробці. Інформація є неповною, може бути недостовірною і/або застарілою, і може значно змінюватися в майбутньому.
 

diff --git a/docs/community.rst b/docs/community.rst
@@ -0,0 +1,33 @@
+:octicon:`people` Спільнота
+===========================
+
+``Rustilka``: Rust для Лілки
+----------------------------
+
+Автор: **black.ghost.off**
+
+Rustilka - це мініпроєкт підтримки мови Rust для Лілки, який має таку саму мету, як і сама консоль - "полегшити" розробку.
+
+Також цей проєкт чисто технічно незалежний від оригінального SDK: при наявності можливостей ми могли б мати IDF версію, але, на думку автора Rustilka, це не має сенсу.
+
+`Хочете писати код для Лілки на Rust? Тоді вам сюди! <https://rust.lilka.dev>`_
+
+``MeowUI``: Альтернативний UI-фреймворк для Лілки
+-------------------------------------------------
+
+Автор: **kolodieiev**
+
+MeowUI - набір бібліотек, що спрощують створення графічного інтерфейсу користувача для електронних пристроїв на базі esp32 та esp32s3.
+
+З самого початку даний проєкт створювався, як шаблон, для швидкої побудови багаторівневого графічного інтерфейсу в стилі “Quadratisch. Praktisch. Gut”.
+Мета - управління різноманітними датчиками за допомогою мікроконтролера ESP32.
+
+Після знайомства з проєктом "Лілка", автором MeowUI було прийнято рішення про розширення та доопрацювання функціоналу MeowUI.
+
+`Детальніше про проєкт можна дізнатися тут. <https://github.com/Kolodieiev/MeowUI>`_
+
+Спілкування
+-----------
+
+- Весь код проєкту доступний на `GitHub <https://github.com/and3rson/lilka>`_.
+- Приєднуйтесь до нашого `Discord-сервера <https://discord.gg/HU68TaKCu6>`_!
diff --git a/docs/conf.py b/docs/conf.py
@@ -39,18 +39,16 @@
 
 # https://protips.readthedocs.io/pdf-font.html
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-    'papersize': 'a4paper',
-
-# The font size ('10pt', '11pt' or '12pt').
-    'pointsize': '11pt',
-
-# Additional stuff for the LaTeX preamble.
-    'preamble': r'''
+    # The paper size ('letterpaper' or 'a4paper').
+    "papersize": "a4paper",
+    # The font size ('10pt', '11pt' or '12pt').
+    "pointsize": "11pt",
+    # Additional stuff for the LaTeX preamble.
+    "preamble": r"""
         \usepackage{charter}
         \usepackage[defaultsans]{lato}
         \usepackage{inconsolata}
-    ''',
+    """,
 }
 
 # -- Custom CSS --------------------------------------------------------------
@@ -79,10 +77,10 @@ def setup(app):
 extensions.append("sphinx_lua")
 
 lua_source_path = ["../sdk/addons/lualilka/"]
-lua_source_encoding = 'utf8'
-lua_source_comment_prefix = '---'
+lua_source_encoding = "utf8"
+lua_source_comment_prefix = "---"
 lua_source_use_emmy_lua_syntax = True
-lua_source_private_prefix = '_'
+lua_source_private_prefix = "_"
 
 # -- Toolbox -----------------------------------------------------------------
 
@@ -94,3 +92,6 @@ def setup(app):
 # -- Graphviz ----------------------------------------------------------------
 
 extensions.append("sphinx.ext.graphviz")
+
+# -- Sphinx-Design ------------------------------------------------------------
+extensions.append("sphinx_design")
diff --git a/docs/faq/index.rst b/docs/faq/index.rst
@@ -1,5 +1,5 @@
-Поширені запитання
-==================
+:octicon:`question` Поширені запитання
+=======================================
 
 .. toctree::
     :maxdepth: 1

diff --git a/docs/glossary.rst b/docs/glossary.rst
@@ -1,5 +1,5 @@
-Словник термінів
-================
+:octicon:`database` Словник термінів
+====================================
 
 .. glossary::
 

diff --git a/docs/hardware/index.rst b/docs/hardware/index.rst
@@ -1,5 +1,5 @@
-Технічні дані
-=============
+:octicon:`cpu` Технічні дані
+============================
 
 .. toctree::
     :maxdepth: 2

diff --git a/docs/index.rst b/docs/index.rst
@@ -20,10 +20,23 @@
     library/index
     faq/index
     glossary
+    community
 
-.. sidebar-links::
-    :caption: Посилання:
-    :github:
+.. .. sidebar-links::
+..     :caption: Посилання:
+..     :github:
+
+.. toctree::
+    :caption: Посилання
+
+    GitHub <https://github.com/and3rson/lilka>
+    Discord <https://discord.gg/HU68TaKCu6>
+
+.. toctree::
+    :caption: Проєкти нашої спільноти
+
+    "Rustilka": Rust для Лілки <https://rust.lilka.dev>
+    "MeowUI": альтернативний UI для Лілки <https://github.com/Kolodieiev/MeowUI>
 
 Indices and tables
 ==================

diff --git a/docs/keira/index.rst b/docs/keira/index.rst
@@ -1,5 +1,5 @@
-Keira OS
-========
+:octicon:`star` Keira OS
+========================
 
 Ми написали для Лілки власну прошивку, яка називається **"Keira OS"** (**Операційна Система "Кіра"**) і включає в себе основні функції для демонстрації можливостей пристрою.
 

diff --git a/docs/library/index.rst b/docs/library/index.rst
@@ -1,7 +1,7 @@
 .. _lilka-lib:
 
-Бібліотека ``lilka``
-====================
+:octicon:`code` Бібліотека ``lilka``
+====================================
 
 Проєкт "Лілка" має однойменну бібліотеку ``lilka``, яка спрощує роботу з Лілкою та дозволяє вам швидко створювати для Лілки власні прошивки мовою програмування C++.
 

diff --git a/docs/manual/index.rst b/docs/manual/index.rst
@@ -1,5 +1,5 @@
-Інструкція
-==========
+:octicon:`book` Інструкція
+==========================
 
 .. toctree::
     :maxdepth: 1

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,5 @@
 breathe==4.35.0
+sphinx-design==0.5.0
 sphinx-lua==1.1.5
 sphinx-rtd-theme==1.3.0
 sphinx-toolbox==3.5.0