Backported changes to the documentation from the 0.2-rewrite branch.

CHANGELOG.md

@@ -26,6 +26,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   "Community" button that opens `tabletopclub.net/community` in the default
   browser.
 - Updated the master server's URL and SSL certificate.
+- Updated the documentation.
 
 ### Removed
 

docs/conf.py

@@ -18,9 +18,15 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Tabletop Club'
+
+# TODO: Sphinx now supports multiple entries for the copyright, but the theme
+# does not display them properly. Edit once the issue has been fixed.
 copyright = "2020-2024, Benjamin 'drwhut' Beddows, Tabletop Club contributors"
 
-# The full version, including alpha/beta/rc tags
+# The major and minor version, excluding the patch number.
+version = 'master'
+
+# The full version, including the patch number, and any alpha/beta/rc tags.
 release = 'master'
 
 
@@ -39,7 +45,10 @@ templates_path = []
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'env', 'Thumbs.db', '.DS_Store']
+
+# Show warnings for all references where the target could not be found.
+nitpicky = True
 
 # Show TODOs in the documentation.
 todo_include_todos = True
@@ -53,11 +62,54 @@ todo_include_todos = True
 html_theme = 'sphinx_book_theme'
 
 html_theme_options = {
-    "path_to_docs": "docs/",
+    "logo": {
+        "alt_text": "Tabletop Club Documentation - Home"
+    },
+
+    "icon_links": [
+        {
+            "name": "Website",
+            "url": "https://tabletopclub.net",
+            "icon": "fa-solid fa-house",
+            "type": "fontawesome"
+        },
+        {
+            "name": "Download",
+            "url": "https://tabletopclub.net/downloads",
+            "icon": "fa-solid fa-download",
+            "type": "fontawesome"
+        },
+        {
+            "name": "News",
+            "url": "https://tabletopclub.net/news",
+            "icon": "fa-solid fa-newspaper",
+            "type": "fontawesome"
+        },
+        {
+            "name": "Community",
+            "url": "https://tabletopclub.net/community",
+            "icon": "fa-solid fa-comments",
+            "type": "fontawesome"
+        },
+        {
+            "name": "Ko-fi",
+            "url": "https://ko-fi.com/drwhut",
+            # TODO: Use brand icon when it becomes available.
+            "icon": "fa-solid fa-mug-hot",
+            "type": "fontawesome"
+        }
+    ],
+
     "repository_url": "https://github.com/drwhut/tabletop-club",
+    "repository_branch": "master",
+    "path_to_docs": "docs/",
+    "use_repository_button": True,
+
     "use_edit_page_button": True,
     "use_issues_button": True,
-    "use_repository_button": True
+    "use_source_button": True,
+
+    "show_toc_level": 2
 }
 
 # Add the project logo and icon to the docs.

docs/requirements.txt

@@ -1,3 +1,3 @@
-sphinx==4.5.0
-sphinx-book-theme==0.3.2
-sphinx-intl==2.0.1
+sphinx==8.0.2
+sphinx-book-theme==1.1.3
+sphinx-intl==2.2.0