Add navigation links to Sphinx config
authorJeremy Stanley <fungi@yuggoth.org>
Mon, 15 Oct 2018 12:49:49 +0000 (12:49 +0000)
committerJeremy Stanley <fungi@yuggoth.org>
Mon, 15 Oct 2018 16:15:57 +0000 (16:15 +0000)
Similar to the project URLs in the Python package configuration,
include some useful hyperlinks in the Sphinx Alabaster sidebar for
things like code browsing/cloning, bug reporting and release files.

doc/source/conf.py

index 17572a2..8d8728d 100755 (executable)
@@ -2,6 +2,7 @@
 # modify, and distribute this software is granted under terms
 # provided in the LICENSE file distributed with this software.
 
+import collections
 import os
 import sys
 
@@ -24,6 +25,12 @@ html_sidebars = {'**': [
 ]}
 html_theme_options = {
     'description': 'The mudpy MUD server engine.',
+    'extra_nav_links': collections.OrderedDict((
+        ('Browse Source', 'https://mudpy.org/code/mudpy/'),
+        ('Bug Reporting', 'https://mudpy.org/bugs/mudpy/'),
+        ('Git Clone URL', 'https://mudpy.org/code/mudpy/'),
+        ('Release Files', 'https://mudpy.org/dist/mudpy/'),
+    )),
     'fixed_sidebar': True,
     'logo_name': True,
     'logo_text_align': 'center',