doc/source/conf.py

   1 # Copyright (c) 2018-2019 mudpy authors. Permission to use, copy,
   2 # modify, and distribute this software is granted under terms
   3 # provided in the LICENSE file distributed with this software.
   4
   5 import collections
   6 import os
   7 import sys
   8
   9 sys.path.insert(0, os.path.abspath('../..'))
  10
  11 project = 'mudpy'
  12
  13 add_function_parentheses = True
  14 add_module_names = True
  15 copyright = '2004-2019, Jeremy Stanley <fungi@yuggoth.org>'
  16 extensions = ['sphinx.ext.autodoc']
  17 html_favicon = '_static/logo.svg'
  18 html_logo = '_static/logo.svg'
  19 html_sidebars = {'**': [
  20     'about.html',
  21     'donate.html',
  22     'navigation.html',
  23     'relations.html',
  24     'searchbox.html',
  25 ]}
  26 html_theme_options = {
  27     'description': 'The mudpy MUD server engine.',
  28     'extra_nav_links': collections.OrderedDict((
  29         ('Browse Source', 'https://mudpy.org/code/mudpy/'),
  30         ('Bug Reporting', 'https://mudpy.org/bugs/mudpy/'),
  31         ('Git Clone URL', 'https://mudpy.org/code/mudpy/'),
  32         ('Release Files', 'https://mudpy.org/dist/mudpy/'),
  33     )),
  34     'fixed_sidebar': True,
  35     'logo_name': True,
  36     'logo_text_align': 'center',
  37 }
  38 html_title = 'mudpy'
  39 htmlhelp_basename = '%sdoc' % project
  40 latex_documents = [(
  41     'index', '%s.tex' % project, '%s' % project, 'Jeremy Stanley', 'manual')]
  42 master_doc = 'index'
  43 pygments_style = 'sphinx'
  44 source_suffix = '.rst'