Демонстрация инструментов Docs¶
Контрольный список тем¶
Эта демонстрация предназначена для тестирования различных функций переопределений темы BeeWare MkDocs Material. Пожалуйста, прочтите и убедитесь, что все, что указано на этой и следующих страницах, присутствует и функционирует в соответствии с описанием.
Заголовок¶
На странице отображается средне-серая строка заголовка. Это означает, что был применен шаблон темы.
Значок заголовка¶
Значок заголовка в левом верхнем углу отображается. Это подтверждает, что шаблон может ссылаться на внешние ресурсы.
Иконка боковой панели домашней страницы¶
Значок логотипа в левой боковой панели был отображен. Логотип должен иметь ширину и высоту, равные ширине и высоте боковой панели. Название сайта должно быть отображено под ним шрифтом, немного большего размера, чем остальная часть боковой панели, а номер версии — под ним шрифтом меньшего размера.
Это подтверждает, что боковая панель будет правильно отображаться на целевых сайтах.
Шрифт заголовка¶
Заголовки отображаются в Cutive. Это подтверждает, что была применена пользовательская CSS-тема BeeWare.
Встроенный код¶
Встроенный код отображается тем же цветом, что и окружающий шрифт. Это подтверждает, что тема не вызвала никаких нежелательных изменений.
Это текст с inline code здесь и inline code здесь.
Код контента с вкладками¶
Код выделяется контрастным цветом на фоне. Кнопка «Копировать» должна копировать только команды; командная строка не должна включаться.
Это подтверждает, что тема не вызвала никаких нежелательных изменений, а также что кнопка копирования работает как ожидалось.
$ git clone https://github.com/beeware/beeware-theme.git
$ git clone https://github.com/beeware/beeware-theme.git
C:\...>git clone https://github.com/beeware/beeware-theme.git
Поведение кнопки копирования кода¶
Кнопка копирования в следующем блоке кода должна привести к копированию from
pathlib import Path в буфер обмена.
from pathlib import Path
Кнопка копирования в следующем блоке кода должна привести к копированию ls
beeware-docs-tools в буфер обмена. Командная строка оболочки и вывод не должны
включаться.
(venv) $ ls beeware-docs-tools
_build locales requirements.dev.txt tox.ini
docs pyproject.toml requirements.docs.txt
LICENSE README.md src
Ссылки в боковой панели¶
Ссылки в боковой панели существуют и указывают на репозиторий
beeware-docs-tools. Это подтверждает, что содержимое боковой панели было
загружено, а project-name был установлен в конфигурационном файле MkDocs, и
номер версии был вычислен и добавлен.
Цвета ссылок¶
Эта ссылка на главный веб-сайт BeeWare должна быть синего цвета как в светлом, так и в темном режиме.
Ссылки в левой и правой боковых панелях также должны быть синего цвета в обоих режимах.
При прокрутке страницы вниз активная ссылка заголовка в правой боковой панели должна быть светло-голубой в темном режиме и темно-голубой в светлом режиме.
Предупреждение о переводе¶
В англоязычной версии этого документа должно отображаться предупреждение «Доступны переводы» ниже. Во французском переводе должно отображаться предупреждение «Это машинный перевод!». В немецком переводе должно отображаться предупреждение «Это перевод!» для переводов, выполненных человеком.
Это машинный перевод!
Эта версия учебника была создана с помощью машинного перевода. Мы понимаем, что это не идеальный вариант, но считаем, что плохой перевод лучше, чем его отсутствие.
Пользовательская страница 404¶
Добавьте nopage в конец URL-адреса в браузере, чтобы убедиться, что страница
404 существует и содержит текст «Brutus не может найти то, что вы ищете».
Текущая страница 404 не всегда отображает изображения из-за проблемы с MkDocs.
MkDocs не может обработать неизвестные внутренние ссылки, поэтому вам необходимо вручную проверить это, изменив URL-адрес в браузере.
Следующие проверки¶
Следующая ссылка должна перенаправить вас в раздел 1 демонстрации инструментов BeeWare Docs. Она включена для проверки межстраничных ссылок.
Перейдите в BeeWare Docs Tools Demo Section One для следующих проверок.