X-Git-Url: https://mudpy.org/gitweb?p=mudpy.git;a=blobdiff_plain;f=doc%2Fsource%2Fconf.py;h=d0f203afce95e4db45d97701ac85856a9b63005f;hp=17b9eba21ca4be0fc48881634271e41a116eac94;hb=0990f14397431811d3bce39b455201b802ad3ae7;hpb=cd63085011ec98a8949fca48217e4efad5558908 diff --git a/doc/source/conf.py b/doc/source/conf.py index 17b9eba..d0f203a 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,41 +1,44 @@ -# Copyright (c) 2018 mudpy authors. Permission to use, copy, +# Copyright (c) 2018-2020 mudpy authors. Permission to use, copy, # modify, and distribute this software is granted under terms # provided in the LICENSE file distributed with this software. +import collections import os import sys sys.path.insert(0, os.path.abspath('../..')) -extensions = ['sphinx.ext.autodoc'] -source_suffix = '.rst' -master_doc = 'index' + project = 'mudpy' -copyright = '2004-2018, Jeremy Stanley ' + add_function_parentheses = True add_module_names = True -pygments_style = 'sphinx' -html_title = 'mudpy' +copyright = '2004-2020, mudpy authors' +extensions = ['sphinx.ext.autodoc'] html_favicon = '_static/logo.svg' html_logo = '_static/logo.svg' -html_theme_options = { - 'description': 'The mudpy MUD server engine.', - 'fixed_sidebar': True, - 'logo_name': True, - 'logo_text_align': 'center', -} -html_sidebars = { - '**': [ +html_sidebars = {'**': [ 'about.html', + 'donate.html', 'navigation.html', 'relations.html', 'searchbox.html', - 'donate.html', - ] +]} +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', } +html_title = 'mudpy' htmlhelp_basename = '%sdoc' % project -latex_documents = [ - ('index', - '%s.tex' % project, - u'%s' % project, - u'Jeremy Stanley', 'manual'), -] +latex_documents = [( + 'index', '%s.tex' % project, '%s' % project, 'Jeremy Stanley', 'manual')] +master_doc = 'index' +pygments_style = 'sphinx' +source_suffix = '.rst'