Изменение конфига RTD (18)

xanytka-devs · Jun 24, 2024 · 2fde000 · 2fde000
1 parent 06fd154
commit 2fde000
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 17 deletions.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -14,9 +14,9 @@ plugins:
             docstring_style: sphinx
 nav:
   - Туториалы:
-    - Основа: 'source/tutorials/home/'
-    - Пакеты: 'source/tutorials/packets/'
-    - Первый треугольник: 'source/tutorials/triangle/'
+    - Создание проекта: 'tutorials/home/'
+    - Пакеты: 'tutorials/packages/'
+    - Первый треугольник: 'tutorials/triangle/'
 markdown_extensions:
   - markdown_include.include:
       base_path: 'source/'

diff --git a/docs/source/tutorials/home.md b/docs/source/tutorials/home.md
@@ -1,10 +1,10 @@
-# Создание первого проекта
+# 🛠 Создание первого проекта
 Для начала разработки вам необходим пустой проект. Давайте разберёмся во вариантах его создания:
 ## Менеджер проектов
 На данный момент самый простой вариант создания проектов вне готовых конфигураций.  
 Всё, что нужно сделать - запустить **prj_manager.cmd**. В нём вы должны указать название проекта и выбрать, будете ли вы использовать сборку через **CMake**.
 ## Вручную
-Надо хардкора? Если нет, то идите дальше: ([след. пункт](https://firesteel.readthedocs.io/ru/latest/tutorials/triangle.html)).  
+Надо хардкора? Если нет, то идите дальше: ([след. пункт](https://firesteel.readthedocs.io/ru/latest/#tutorials/packages/)).  
 Если же не шутить, то это очень просто.
 1. Создаём папку для проекта 
 Если вы используете **CMake**, то лучше создавайте папку прямо в папке с клонировнным репозиторием Firesteel.
@@ -39,4 +39,4 @@ add_subdirectory(название_проекта)
 
 # Заключение
 На этом данная статья закончена. Как улучшение комфорта использования Wiki в каждой следующей статье в конце документа будет две кнопки (одна на статью назад, другая - вперёд).  
-[<- На страницу firesteel](https://github.com/xanytka-devs/firesteel) | [Первый треугольник ->](https://firesteel.readthedocs.io/ru/latest/tutorials/triangle.html)
+[<- На страницу firesteel](https://github.com/xanytka-devs/firesteel) | [Пакеты ->](https://firesteel.readthedocs.io/ru/latest/#tutorials/packages/)
diff --git a/docs/source/tutorials/packets.md → docs/source/tutorials/packages.md b/docs/source/tutorials/packets.md → docs/source/tutorials/packages.md
@@ -1,4 +1,4 @@
-# Пакеты - что это такое и с чем их едят?
+# 🛍 Пакеты - что это такое и с чем их едят?
 Пакет (или Package) - это контейнер с готовым кодом для Firesteel. Этот код может быть надстройкой для уже существующего, так и совершенно новый.
 
 # Качаем пакеты
@@ -11,8 +11,8 @@
 Вручную скачать пакет очень просто. Всего лишь нужно:  
 1. Скачать архив с кодом  
 Для кода от Ханутки вам нужно скачать пакет из одного из источников:  
-* https://xanytka.ru/p  
-* https://github.com/xanytka-devs/fs-packages  
+* [https://xanytka.ru/p](https://xanytka.ru/p)  
+* [https://github.com/xanytka-devs/fs-packages](https://github.com/xanytka-devs/fs-packages)  
 2. Разархивировать его в корневую папку движка (не забудьте удалить "xepkg.json" потом).  
 3. Собрать проект и радоваться результату
 
@@ -44,4 +44,4 @@
 
 # Заключение
 Теперь вы можете с лёгкостью создавать и скачивать пакеты.  
-[<- Создание первого проекта](https://firesteel.readthedocs.io/ru/latest/tutorials/home.html) | [Первый треугольник ->](https://firesteel.readthedocs.io/ru/latest/tutorials/triangle.html)
+[<- Создание первого проекта](https://firesteel.readthedocs.io/ru/latest/#tutorials/home/) | [Первый треугольник ->](https://firesteel.readthedocs.io/ru/latest/#tutorials/triangle/)
diff --git a/docs/source/tutorials/triangle.md b/docs/source/tutorials/triangle.md
@@ -1,19 +1,17 @@
-# Предусловие
+# 🔼 Предусловие
 Начнём с простого - "Hello World!" на **Firesteel**.
 
 # Отрисовка окна
-Для создания простого окна нужно [скачать пакет](https://firesteel.readthedocs.io/ru/latest/tutorials/packets.html) "fs.rendering.opengl" (или любой другой для отображения) в файл **main.cpp** добавить несколько простых строчек кода:
+Для создания простого окна нужно [скачать пакет](https://firesteel.readthedocs.io/ru/latest/#tutorials/packets/) "fs.rendering.opengl" (или любой другой для отображения) в файл **main.cpp** добавить несколько простых строчек кода:
 ``` cpp
-#include <memory>
 #include <firesteel/app.hpp>
 using namespace firesteel;
 class HelloWorldApp : public App { };
 
 int main() {
     //Create instance of app.
-    auto app = std::make_unique<HelloWorldApp>();
-    int returnC = app->start(800, 600, "Hello World!");
-    return 0;
+    auto app = new HelloWorldApp();
+    return app->start(800, 600, "Hello World!");
 }
 ```
 
@@ -119,4 +117,4 @@ void main() {
 # Заключение
 После всех этих действий вы будете иметь окно с треугольником, какой обычно создают как "Hello World" на OpenGL или других графических библиотеках.  
 Итоговый код: [https://github.com/xanytka-devs/fs-examples/tree/main/triangle_demo](https://github.com/xanytka-devs/fs-examples/tree/main/triangle_demo)  
-[<- Создание первого проекта](https://firesteel.readthedocs.io/ru/latest/tutorials/home.html) | [Продолжение... ->](https://firesteel.readthedocs.io/ru/latest/tutorials/home.html)
+[<- Пакеты](https://firesteel.readthedocs.io/ru/latest/#tutorials/packages/) | [Продолжение... ->](https://firesteel.readthedocs.io/ru/latest/#tutorials/home/)