diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..0a0f169 --- /dev/null +++ b/.readthedocs.yaml @@ -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 diff --git a/docs/base.html b/docs/base.html new file mode 100644 index 0000000..5765f17 --- /dev/null +++ b/docs/base.html @@ -0,0 +1,4 @@ +{% extends "base.html" %} +{% block outdated %} +You're not viewing the latest version. Click here to go to latest. +{% endblock %} diff --git a/mkdocs.rtd.yml b/mkdocs.rtd.yml index 70236c5..48b0e72 100644 --- a/mkdocs.rtd.yml +++ b/mkdocs.rtd.yml @@ -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 diff --git a/pyproject.toml b/pyproject.toml index 1877079..78e2282 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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",