Учимся работать с Bash на Raspberry Pi Zero 2 W — первые шаги в нашей документации!

Одноплатный компбютер G-30 покупал тут https://megabonus.com/y/AvQXs Демонстрационная плата Raspberry Pi Zero 2 W продается тут https://megabonus.com/y/oBqyG === 📌 В этом видео мы демонстрируем, как мы оформили и запустили нашу первую документацию с помощью Sphinx на локальном сервере dochub.local. Документация состоит из трёх вступительных файлов по теме Bash: === 🏠 home.rst — Добро пожаловать в Bash: краткий обзор того, что такое командная оболочка и зачем она нужна. ✨ intro.rst — Введение в мир Bash: простыми словами объясняем, что такое Bash, его особенности и преимущества на примере Raspberry Pi Zero 2 W. 🚀 get_started.rst — Первый запуск: базовая команда bash --version, как понимать вывод терминала и как не бояться текстового интерфейса. 💡 Мы оформили их с помощью reStructuredText (.rst), собрали с помощью sphinx-build и получили полноценную HTML-документацию, которую легко просматривать в браузере по адресу http://dochub.local. всё получилось супер-пупер! 🎉 Оформим краткие **описания трёх файлов**, итоговый **`index.rst`**, а также **пошаговую инструкцию**: как собрать документацию Sphinx и загрузить её на сервер. И в **P.S.** расскажу, как установить `sphinx` и тему через `apt` для Raspberry Pi OS (например, на Raspberry Pi Zero 2 W). == ## 📁 Описание трёх rst-файлов: === ### 1. `home.rst` — **Добро пожаловать в Bash** Это вводная страница, где мы кратко рассказали: * Что такое Bash и зачем он нужен на Raspberry Pi. * Почему командная строка — мощный инструмент. * Как мы будем изучать Bash — просто, пошагово, с примерами. --- ### 2. `intro.rst` — **Понимание оболочек** Здесь мы изучили: * Что такое **оболочка** (shell). * Виды оболочек: `sh`, `csh`, `ksh`, `bash`. * Почему Bash — самый популярный выбор. * Как выглядит команда и её вывод в терминале. --- ### 3. `get_started.rst` — **Первое знакомство** Мы узнали: * Как определить версию Bash (`bash --version`). * Как открыть терминал на Raspberry Pi. * Основу работы с командами и их выводом. * Что не стоит бояться командной строки — всё станет понятно по ходу! --- ## 📚 Итоговый `index.rst` ```rst .. _bash_index: ######################## Учебник по Bash для RPi ######################## Добро пожаловать в наш мини-курс по Bash — идеальной оболочке для Raspberry Pi Zero 2 W! Здесь вы узнаете, как использовать терминал, выполнять команды и создавать скрипты, которые автоматизируют задачи на вашем мини-компьютере. .. toctree:: :maxdepth: 2 :caption: Bash Основы home intro get_started ``` --- ## 🚀 Как собрать и загрузить документацию Sphinx ### 📦 1. Установка Sphinx и темы через `apt` ```bash sudo apt update sudo apt install python3-sphinx sudo apt install sphinx-rtd-theme ``` (Тема `sphinx_rtd_theme` — это классическая "Read the Docs"-тема) --- ### 📁 2. Структура проекта ``` bash/ ├── conf.py ├── index.rst ← Главный индекс ├── home.rst ├── intro.rst ├── get_started.rst ``` --- ### ⚙️ 3. Генерация HTML-документации Перейдите в каталог, где `conf.py` и `index.rst`: ```bash make html ``` Или: ```bash sphinx-build -b html . _build/html ``` 📂 В результате сайт появится в `./_build/html/index.html` --- ### 🌐 4. Загрузка на сервер Например, через `scp` на удалённый сервер: ```bash scp -r _build/html/* user@your-server.com:/var/www/html/bash-docs/ ``` Теперь документация доступна по адресу `http://your-server.com/bash-docs/` --- ## 📝 P.S. Установка Sphinx и темы на Raspberry Pi Zero 2 W (через APT) ```bash sudo apt update sudo apt install python3-sphinx sudo apt install python3-sphinx-rtd-theme ``` (в некоторых системах тема может идти под названием `python3-sphinx-rtd-theme`, если нет — установите через `pip`) --- Хочешь, я сделаю тебе и `conf.py` шаблон под этот проект?