Fix doc structure & sphinx warnings.

dronefly-garden · Mar 17, 2024 · e08371d · e08371d
1 parent 316305a
commit e08371d
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 13 deletions.
diff --git 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 → docs/dronefly_bot.rst b/docs/dronefly.rst → 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 <https://github.com/Cog-Creators/Red-DiscordBot>`__ 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
 <https://github.com/dronefly-garden/dronefly/wiki/Server-owner-guide>`__ here.
diff --git 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