From e08371d3d67974af40252a70f54dc128ddad8703 Mon Sep 17 00:00:00 2001 From: Ben Armstrong Date: Sun, 17 Mar 2024 18:43:07 -0300 Subject: [PATCH] Fix doc structure & sphinx warnings. --- docs/conf.py | 2 ++ docs/{dronefly.rst => dronefly_bot.rst} | 16 ++++++++-------- docs/index.rst | 10 +++++----- 3 files changed, 15 insertions(+), 13 deletions(-) rename docs/{dronefly.rst => dronefly_bot.rst} (88%) diff --git a/docs/conf.py b/docs/conf.py index d74e1f00..3b12b5d8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,6 +40,8 @@ # "sphinxcontrib_trio", ] +intersphinx_mapping = {"redbot": ("https://docs.discord.red/en/stable", None)} + # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/docs/dronefly.rst b/docs/dronefly_bot.rst similarity index 88% rename from docs/dronefly.rst rename to docs/dronefly_bot.rst index 8f1ff76f..e97e26b9 100644 --- a/docs/dronefly.rst +++ b/docs/dronefly_bot.rst @@ -1,11 +1,8 @@ -.. Dronefly +.. Dronefly Bot ======== -Dronefly -======== - Overview --------- +======== .. image:: https://img.shields.io/badge/Red--DiscordBot-cogs-red.svg :target: https://github.com/Cog-Creators/Red-DiscordBot/tree/V3/develop @@ -30,8 +27,9 @@ https://discord.gg/pUbZFDbDdD if: - you already use Dronefly and need support - you want to be involved with Dronefly development +======================= Dronefly cog repository ------------------------ +======================= Dronefly bot is based on `Red Discord Bot `__ but it is also the @@ -46,13 +44,15 @@ download anything from this site to do that. If you do want to run your own bot with the cogs from Dronefly repository on it, see the Installation instructions below. +================================== User Guide - iNaturalist (inatcog) ----------------------------------- +================================== TODO: migrate Guide for Participant material here. +================== Server Owner Guide ------------------- +================== TODO: migrate `Server owner guide `__ here. diff --git a/docs/index.rst b/docs/index.rst index 9deb582d..93d9ba30 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,25 +3,25 @@ Welcome to Dronefly's documentation! .. toctree:: :maxdepth: 2 - :caption: Dronefly: + :caption: Dronefly Bot - dronefly + dronefly_bot .. toctree:: :maxdepth: 2 - :caption: iNaturalist Discord Server: + :caption: iNaturalist Discord Server guide_for_participants .. toctree:: :maxdepth: 2 - :caption: Developer's Reference: + :caption: Developer's Reference development_plan .. toctree:: :maxdepth: 2 - :caption: Dronefly cogs API: + :caption: Dronefly cogs API source/modules.rst