From eddd57cd87b8e404daa2d4e05cf9e936fd090309 Mon Sep 17 00:00:00 2001 From: Jeremy Stanley Date: Mon, 15 Oct 2018 12:43:22 +0000 Subject: [PATCH] Reorganize Sphinx config For improved manageability, sort the contents of the Sphinx conf.py file alphabetically, and switch to the same indentation style as the rest of the codebase. --- doc/source/conf.py | 40 ++++++++++++++++++---------------------- 1 file changed, 18 insertions(+), 22 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 17b9eba..17572a2 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -6,36 +6,32 @@ 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-2018, Jeremy Stanley ' +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.', + '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' -- 2.11.0