doc/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # MIT Kerberos documentation build configuration file, created by
   4 # sphinx-quickstart on Wed Oct 13 09:14:03 2010.
   5 #
   6 # This file is execfile()d with the current directory set to its containing dir.
   7 #
   8 # Note that not all possible configuration values are present in this
   9 # autogenerated file.
  10 #
  11 # All configuration values have a default; values that are commented out
  12 # serve to show the default.
  13
  14 import sys, os
  15
  16 # If extensions (or modules to document with autodoc) are in another directory,
  17 # add these directories to sys.path here. If the directory is relative to the
  18 # documentation root, use os.path.abspath to make it absolute, like shown here.
  19 #sys.path.insert(0, os.path.abspath('.'))
  20
  21 # -- General configuration -----------------------------------------------------
  22
  23 # If your documentation needs a minimal Sphinx version, state it here.
  24 #needs_sphinx = '1.0'
  25
  26 # Add any Sphinx extension module names here, as strings. They can be extensions
  27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  28 #extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.doxylink']
  29 extensions = ['sphinx.ext.autodoc']
  30
  31 # Add any paths that contain templates here, relative to this directory.
  32 templates_path = ['_templates']
  33
  34 # The suffix of source filenames.
  35 source_suffix = '.rst'
  36
  37 # The encoding of source files.
  38 #source_encoding = 'utf-8-sig'
  39
  40 # The master toctree document.
  41 if 'notice' in tags:
  42     master_doc = 'notice'
  43 else:
  44     master_doc = 'index'
  45
  46 # General information about the project.
  47 project = u'MIT Kerberos'
  48 copyright = u'1985-2019, MIT'
  49
  50 # The version info for the project you're documenting, acts as replacement for
  51 # |version| and |release|, also used in various other places throughout the
  52 # built documents.
  53 exec(open("version.py").read())
  54 # The short X.Y version.
  55 r_list = [r_major, r_minor]
  56 if r_patch:
  57     r_list += [r_patch]
  58 version = '.'.join(map(str, r_list))
  59 # The full version, including alpha/beta/rc tags.
  60 release = version
  61 if r_tail:
  62     release += '-' + r_tail
  63
  64 # The language for content autogenerated by Sphinx. Refer to documentation
  65 # for a list of supported languages.
  66 #language = None
  67
  68 # There are two options for replacing |today|: either, you set today to some
  69 # non-false value, then it is used:
  70 today = ' '
  71 # Else, today_fmt is used as the format for a strftime call.
  72 #today_fmt = '%B %d, %Y'
  73
  74 # List of patterns, relative to source directory, that match files and
  75 # directories to ignore when looking for source files.
  76 exclude_patterns = []
  77
  78 # The reST default role (used for this markup: `text`) to use for all documents.
  79 #default_role = None
  80
  81 # If true, '()' will be appended to :func: etc. cross-reference text.
  82 #add_function_parentheses = True
  83
  84 # If true, the current module name will be prepended to all description
  85 # unit titles (such as .. function::).
  86 #add_module_names = True
  87
  88 # If true, sectionauthor and moduleauthor directives will be shown in the
  89 # output. They are ignored by default.
  90 #show_authors = False
  91
  92 # The name of the Pygments (syntax highlighting) style to use.
  93 pygments_style = 'sphinx'
  94
  95 # A list of ignored prefixes for module index sorting.
  96 #modindex_common_prefix = []
  97
  98
  99 # -- Options for HTML output ---------------------------------------------------
 100
 101 # The theme to use for HTML and HTML Help pages.  See the documentation for
 102 # a list of builtin themes.
 103 # html_theme = 'default'
 104 html_theme = 'agogo'
 105
 106 # Theme options are theme-specific and customize the look and feel of a theme
 107 # further.  For a list of options available for each theme, see the
 108 # documentation.
 109 html_theme_options = { "linkcolor": "#881f0d", "footerbg":  "#5d1509",
 110                        "bgcolor": "#5d1509", "documentwidth": "80%",
 111                        "pagewidth": "auto", "sidebarwidth": "20%" }
 112
 113 # Add any paths that contain custom themes here, relative to this directory.
 114 #html_theme_path = []
 115
 116 # The name for this set of Sphinx documents.  If None, it defaults to
 117 # "<project> v<release> documentation".
 118 html_title = "MIT Kerberos Documentation"
 119
 120 # A shorter title for the navigation bar.  Default is the same as html_title.
 121 #html_short_title = None
 122
 123 # The name of an image file (relative to this directory) to place at the top
 124 # of the sidebar.
 125 if os.environ.get('HTML_LOGO'):
 126     html_logo = os.environ['HTML_LOGO']
 127
 128 # The name of an image file (within the static path) to use as favicon of the
 129 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 130 # pixels large.
 131 #html_favicon = None
 132
 133 # Add any paths that contain custom static files (such as style sheets) here,
 134 # relative to this directory. They are copied after the builtin static files,
 135 # so a file named "default.css" will overwrite the builtin "default.css".
 136 html_static_path = ['_static']
 137
 138 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 139 # using the given strftime format.
 140 #html_last_updated_fmt = '%b %d, %Y'
 141
 142 # If true, SmartyPants will be used to convert quotes and dashes to
 143 # typographically correct entities.
 144 html_use_smartypants = True
 145
 146 # Custom sidebar templates, maps document names to template names.
 147 #html_sidebars = {}
 148
 149 # Additional templates that should be rendered to pages, maps page names to
 150 # template names.
 151 #html_additional_pages = {}
 152
 153 # If false, no module index is generated.
 154 #html_domain_indices = True
 155
 156 # If false, no index is generated.
 157 #html_use_index = True
 158
 159 # If true, the index is split into individual pages for each letter.
 160 html_split_index = True
 161
 162 # If true, links to the reST sources are added to the pages.
 163 html_show_sourcelink = False
 164
 165 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 166 #html_show_sphinx = True
 167
 168 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 169 #html_show_copyright = True
 170
 171 # If true, an OpenSearch description file will be output, and all pages will
 172 # contain a <link> tag referring to it.  The value of this option must be the
 173 # base URL from which the finished HTML is served.
 174 #html_use_opensearch = ''
 175
 176 # This is the file name suffix for HTML files (e.g., ".xhtml").
 177 #html_file_suffix = None
 178
 179 # Output file base name for HTML help builder.
 180 htmlhelp_basename = 'MIT Kerberos'
 181
 182 pointsize = '10pt'
 183
 184 # -- Options for LaTeX output --------------------------------------------------
 185
 186 # The paper size ('letter' or 'a4').
 187 #latex_paper_size = 'letter'
 188
 189 # The font size ('10pt', '11pt' or '12pt').
 190 #latex_font_size = '10pt'
 191
 192 # Grouping the document tree into LaTeX files. List of tuples
 193 # (source start file, target name, title, author, documentclass [howto/manual]).
 194 latex_documents = [
 195   ('admin/index', 'admin.tex', u"Kerberos Administration Guide", u'MIT',
 196    'manual'),
 197   ('appdev/index', 'appdev.tex', u"Kerberos Application Developer Guide",
 198    u'MIT', 'manual'),
 199   ('basic/index', 'basic.tex', u"Kerberos Concepts", u'MIT', 'manual'),
 200   ('build/index', 'build.tex', u"Building MIT Kerberos", u'MIT', 'manual'),
 201   ('plugindev/index', 'plugindev.tex', u"Kerberos Plugin Module Developer Guide",
 202    u'MIT', 'manual'),
 203   ('user/index', 'user.tex', u"Kerberos User Guide", u'MIT', 'manual')
 204 ]
 205
 206 # The name of an image file (relative to this directory) to place at the top of
 207 # the title page.
 208 #latex_logo = None
 209
 210 # For "manual" documents, if this is true, then toplevel headings are parts,
 211 # not chapters.
 212 #latex_use_parts = False
 213
 214 # If true, show page references after internal links.
 215 #latex_show_pagerefs = False
 216
 217 # If true, show URL addresses after external links.
 218 #latex_show_urls = False
 219
 220 # Additional stuff for the LaTeX preamble.
 221 #latex_preamble = ''
 222
 223 # Documents to append as an appendix to all manuals.
 224 #latex_appendices = []
 225
 226 # If false, no module index is generated.
 227 #latex_domain_indices = True
 228
 229 if 'mansubs' in tags:
 230     bindir = '``@BINDIR@``'
 231     sbindir = '``@SBINDIR@``'
 232     libdir = '``@LIBDIR@``'
 233     localstatedir = '``@LOCALSTATEDIR@``'
 234     runstatedir = '``@RUNSTATEDIR@``'
 235     sysconfdir = '``@SYSCONFDIR@``'
 236     ccache = '``@CCNAME@``'
 237     keytab = '``@KTNAME@``'
 238     ckeytab = '``@CKTNAME@``'
 239 elif 'pathsubs' in tags:
 240     # Read configured paths from a file produced by the build system.
 241     exec(open("paths.py").read())
 242 else:
 243     bindir = ':ref:`BINDIR <paths>`'
 244     sbindir = ':ref:`SBINDIR <paths>`'
 245     libdir = ':ref:`LIBDIR <paths>`'
 246     localstatedir = ':ref:`LOCALSTATEDIR <paths>`'
 247     runstatedir = ':ref:`RUNSTATEDIR <paths>`'
 248     sysconfdir = ':ref:`SYSCONFDIR <paths>`'
 249     ccache = ':ref:`DEFCCNAME <paths>`'
 250     keytab = ':ref:`DEFKTNAME <paths>`'
 251     ckeytab = ':ref:`DEFCKTNAME <paths>`'
 252
 253 rst_epilog = '\n'
 254
 255 if 'notice' in tags:
 256     exclude_patterns = [ 'admin', 'appdev', 'basic', 'build',
 257                          'plugindev', 'user' ]
 258     exclude_patterns += [ 'about.rst', 'build_this.rst', 'copyright.rst',
 259                           'index.rst', 'mitK5*.rst', 'resources.rst' ]
 260     rst_epilog += '.. |copy| replace:: \(C\)'
 261 else:
 262     exclude_patterns += [ 'notice.rst' ]
 263     rst_epilog += '.. |bindir| replace:: %s\n' % bindir
 264     rst_epilog += '.. |sbindir| replace:: %s\n' % sbindir
 265     rst_epilog += '.. |libdir| replace:: %s\n' % libdir
 266     rst_epilog += '.. |kdcdir| replace:: %s\\ ``/krb5kdc``\n' % localstatedir
 267     rst_epilog += '.. |kdcrundir| replace:: %s\\ ``/krb5kdc``\n' % runstatedir
 268     rst_epilog += '.. |sysconfdir| replace:: %s\n' % sysconfdir
 269     rst_epilog += '.. |ccache| replace:: %s\n' % ccache
 270     rst_epilog += '.. |keytab| replace:: %s\n' % keytab
 271     rst_epilog += '.. |ckeytab| replace:: %s\n' % ckeytab
 272     rst_epilog += '''
 273 .. |krb5conf| replace:: ``/etc/krb5.conf``
 274 .. |defkeysalts| replace:: ``aes256-cts-hmac-sha1-96:normal aes128-cts-hmac-sha1-96:normal des3-cbc-sha1:normal arcfour-hmac-md5:normal``
 275 .. |defetypes| replace:: ``aes256-cts-hmac-sha1-96 aes128-cts-hmac-sha1-96 aes256-cts-hmac-sha384-192 aes128-cts-hmac-sha256-128 des3-cbc-sha1 arcfour-hmac-md5 camellia256-cts-cmac camellia128-cts-cmac des-cbc-crc des-cbc-md5 des-cbc-md4``
 276 .. |defmkey| replace:: ``aes256-cts-hmac-sha1-96``
 277 .. |copy| unicode:: U+000A9
 278 '''
 279
 280 # -- Options for manual page output --------------------------------------------
 281
 282 # One entry per manual page. List of tuples
 283 # (source start file, name, description, authors, manual section).
 284 man_pages = [
 285     ('user/user_commands/kinit', 'kinit', u'obtain and cache Kerberos ticket-granting ticket', [u'MIT'], 1),
 286     ('user/user_commands/klist', 'klist', u'list cached Kerberos tickets', [u'MIT'], 1),
 287     ('user/user_commands/kdestroy', 'kdestroy', u'destroy Kerberos tickets', [u'MIT'], 1),
 288     ('user/user_commands/kswitch', 'kswitch', u'switch primary ticket cache', [u'MIT'], 1),
 289     ('user/user_commands/kpasswd', 'kpasswd', u'change a user\'s Kerberos password', [u'MIT'], 1),
 290     ('user/user_commands/kvno', 'kvno', u'print key version numbers of Kerberos principals', [u'MIT'], 1),
 291     ('user/user_commands/ksu', 'ksu', u'Kerberized super-user', [u'MIT'], 1),
 292     ('user/user_commands/krb5-config', 'krb5-config', u'tool for linking against MIT Kerberos libraries', [u'MIT'], 1),
 293     ('user/user_config/k5login', 'k5login', u'Kerberos V5 acl file for host access', [u'MIT'], 5),
 294     ('user/user_config/k5identity', 'k5identity', u'Kerberos V5 client principal selection rules', [u'MIT'], 5),
 295     ('user/user_config/kerberos', 'kerberos', u'Overview of using Kerberos', [u'MIT'], 7),
 296     ('admin/admin_commands/krb5kdc', 'krb5kdc', u'Kerberos V5 KDC', [u'MIT'], 8),
 297     ('admin/admin_commands/kadmin_local', 'kadmin', u'Kerberos V5 database administration program', [u'MIT'], 1),
 298     ('admin/admin_commands/kprop', 'kprop', u'propagate a Kerberos V5 principal database to a replica server', [u'MIT'], 8),
 299     ('admin/admin_commands/kproplog', 'kproplog', u'display the contents of the Kerberos principal update log', [u'MIT'], 8),
 300     ('admin/admin_commands/kpropd', 'kpropd', u'Kerberos V5 replica KDC update server', [u'MIT'], 8),
 301     ('admin/admin_commands/kdb5_util', 'kdb5_util', u'Kerberos database maintenance utility', [u'MIT'], 8),
 302     ('admin/admin_commands/ktutil', 'ktutil', u'Kerberos keytab file maintenance utility', [u'MIT'], 1),
 303     ('admin/admin_commands/k5srvutil', 'k5srvutil', u'host key table (keytab) manipulation utility', [u'MIT'], 1),
 304     ('admin/admin_commands/kadmind', 'kadmind', u'KADM5 administration server', [u'MIT'], 8),
 305     ('admin/admin_commands/kdb5_ldap_util', 'kdb5_ldap_util', u'Kerberos configuration utility', [u'MIT'], 8),
 306     ('admin/conf_files/krb5_conf', 'krb5.conf', u'Kerberos configuration file', [u'MIT'], 5),
 307     ('admin/conf_files/kdc_conf', 'kdc.conf', u'Kerberos V5 KDC configuration file', [u'MIT'], 5),
 308     ('admin/conf_files/kadm5_acl', 'kadm5.acl', u'Kerberos ACL file', [u'MIT'], 5),
 309     ('user/user_commands/sclient', 'sclient', u'sample Kerberos version 5 client', [u'MIT'], 1),
 310     ('admin/admin_commands/sserver', 'sserver', u'sample Kerberos version 5 server', [u'MIT'], 8),
 311 ]