From b7911f191b8bcacb054a5f1c2d1dea85ba925a22 Mon Sep 17 00:00:00 2001 From: "Roger A. Light" Date: Sun, 12 Jul 2020 09:20:36 +0100 Subject: [PATCH] Add all docs to documentation page. --- www/conf.py | 1 + www/pages/documentation.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 29 insertions(+) diff --git a/www/conf.py b/www/conf.py index 8c41bec4..6018b89a 100644 --- a/www/conf.py +++ b/www/conf.py @@ -87,6 +87,7 @@ NAVIGATION_LINKS = { #("/sponsoring/", "Sponsoring"), ( ( + ("/documentation/", "All"), ("/roadmap/", "Roadmap"), ("/api/", "API"), ("/man/libmosquitto-3.html", "libmosquitto"), diff --git a/www/pages/documentation.md b/www/pages/documentation.md index af4ed0f8..b4b12468 100644 --- a/www/pages/documentation.md +++ b/www/pages/documentation.md @@ -9,6 +9,34 @@ .. type: text --> +# Man pages + +* [mosquitto] - running the Mosquitto broker +* [mosquitto.conf] - the Mosquitto broker configuration file +* [mosquitto_passwd] - command line utility for generating Mosquitto password files +* [mosquitto_pub] - command line utility for publishing messages to a broker +* [mosquitto_rr] - command line utility for simple request/response with a broker +* [mosquitto_sub] - command line utility for subscribing to topics on a broker +* [mosquitto-tls] - brief cheat sheet for creating x509 certificates +* [mqtt] - description of MQTT features + +# libmosquitto API + +* [libmosquitto API documentation] + +# Other + * [Using the snap package] - specific instructions on installing and configuring the Mosquitto snap package. +[mosquitto]:/man/mosquitto-8.html +[mosquitto.conf]:/man/mosquitto-conf-5.html +[mosquitto_passwd]:/man/mosquitto_passwd-1.html +[mosquitto_pub]:/man/mosquitto_pub-1.html +[mosquitto_rr]:/man/mosquitto_rr-1.html +[mosquitto_sub]:/man/mosquitto_sub-1.html +[mosquitto-tls]:/man/mosquitto-tls-7.html +[mqtt]:/man/mqtt-7.html + +[libmosquitto API documentation]:/api/ + [Using the snap package]:/documentation/using-the-snap/