adding configuration for readthedocs

pull/208/head
Andrew Mirsky 2025-06-11 11:51:27 -04:00
rodzic ee7a88fc72
commit 09fa23dc22
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: A98E67635CDF2C39
4 zmienionych plików z 24 dodań i 3 usunięć

12
.readthedocs.yaml 100644
Wyświetl plik

@ -0,0 +1,12 @@
version: 2
build:
os: "ubuntu-24.04"
tools:
python: "3.12"
jobs:
pre_install:
- pip install --group docs
mkdocs:
configuration: mkdocs.rtd.yml

4
docs/base.html 100644
Wyświetl plik

@ -0,0 +1,4 @@
{% extends "base.html" %}
{% block outdated %}
You're not viewing the latest version. <a href="{{ '../' ~ base_url }}"><strong>Click here to go to latest.</strong></a>
{% endblock %}

Wyświetl plik

@ -1,7 +1,7 @@
# MKDocs configuration file for generating RTD (readthedocs) documentation
site_name: ""
site_description: "MQTT broker and client natively implemented with Python's asyncio"
site_name: "aMQTT"
site_description: "Python's asyncio-native MQTT broker and client."
site_url: http://github.com
repo_url: https://github.com/Yakifo/amqtt
repo_name: Yakifo/amqtt
@ -56,6 +56,8 @@ nav:
theme:
name: material
logo: assets/amqtt_bw.svg
extend:
- base.html
features:
- announce.dismiss
- content.action.edit
@ -164,6 +166,9 @@ plugins:
- typeset
extra:
version:
provider: readthedocs
default: latest
social:
- icon: fontawesome/brands/github
link: https://github.com/pawamoy

Wyświetl plik

@ -5,7 +5,7 @@ build-backend = "hatchling.build"
[project]
name = "amqtt"
description = "MQTT client/broker using Python asyncio"
description = "Python's asyncio-native MQTT broker and client."
classifiers = [
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",