1 # -*- coding: utf-8 -*-
3 # MIT Kerberos documentation build configuration file, created by
4 # sphinx-quickstart on Wed Oct 13 09:14:03 2010.
6 # This file is execfile()d with the current directory set to its containing dir.
8 # Note that not all possible configuration values are present in this
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
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('.'))
21 # -- General configuration -----------------------------------------------------
23 # If your documentation needs a minimal Sphinx version, state it here.
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 #extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.doxylink']
32 # 'krb5doxy' : ('path-to-doxygen-tag-file/krb5doxy.tag', 'location-of-doxygen-html-output/'),
35 # Add any paths that contain templates here, relative to this directory.
36 templates_path = ['_templates']
38 # The suffix of source filenames.
39 source_suffix = '.rst'
41 # The encoding of source files.
42 #source_encoding = 'utf-8-sig'
44 # The master toctree document.
47 # General information about the project.
48 project = u'MIT Kerberos'
49 copyright = u'2011, MIT'
51 # The version info for the project you're documenting, acts as replacement for
52 # |version| and |release|, also used in various other places throughout the
55 # The short X.Y version.
57 # The full version, including alpha/beta/rc tags.
60 # The language for content autogenerated by Sphinx. Refer to documentation
61 # for a list of supported languages.
64 # There are two options for replacing |today|: either, you set today to some
65 # non-false value, then it is used:
67 # Else, today_fmt is used as the format for a strftime call.
68 #today_fmt = '%B %d, %Y'
70 # List of patterns, relative to source directory, that match files and
71 # directories to ignore when looking for source files.
74 # The reST default role (used for this markup: `text`) to use for all documents.
77 # If true, '()' will be appended to :func: etc. cross-reference text.
78 #add_function_parentheses = True
80 # If true, the current module name will be prepended to all description
81 # unit titles (such as .. function::).
82 #add_module_names = True
84 # If true, sectionauthor and moduleauthor directives will be shown in the
85 # output. They are ignored by default.
88 # The name of the Pygments (syntax highlighting) style to use.
89 pygments_style = 'sphinx'
91 # A list of ignored prefixes for module index sorting.
92 #modindex_common_prefix = []
95 # -- Options for HTML output ---------------------------------------------------
97 # The theme to use for HTML and HTML Help pages. See the documentation for
98 # a list of builtin themes.
99 # html_theme = 'default'
100 html_theme = 'sphinxdoc'
102 # Theme options are theme-specific and customize the look and feel of a theme
103 # further. For a list of options available for each theme, see the
105 #html_theme_options = {}
107 # Add any paths that contain custom themes here, relative to this directory.
108 #html_theme_path = []
110 # The name for this set of Sphinx documents. If None, it defaults to
111 # "<project> v<release> documentation".
114 # A shorter title for the navigation bar. Default is the same as html_title.
115 #html_short_title = None
117 # The name of an image file (relative to this directory) to place at the top
121 # The name of an image file (within the static path) to use as favicon of the
122 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
126 # Add any paths that contain custom static files (such as style sheets) here,
127 # relative to this directory. They are copied after the builtin static files,
128 # so a file named "default.css" will overwrite the builtin "default.css".
129 html_static_path = ['_static']
131 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
132 # using the given strftime format.
133 #html_last_updated_fmt = '%b %d, %Y'
135 # If true, SmartyPants will be used to convert quotes and dashes to
136 # typographically correct entities.
137 html_use_smartypants = True
139 # Custom sidebar templates, maps document names to template names.
142 # Additional templates that should be rendered to pages, maps page names to
144 #html_additional_pages = {}
146 # If false, no module index is generated.
147 #html_domain_indices = True
149 # If false, no index is generated.
150 #html_use_index = True
152 # If true, the index is split into individual pages for each letter.
153 html_split_index = True
155 # If true, links to the reST sources are added to the pages.
156 #html_show_sourcelink = True
158 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
159 #html_show_sphinx = True
161 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
162 #html_show_copyright = True
164 # If true, an OpenSearch description file will be output, and all pages will
165 # contain a <link> tag referring to it. The value of this option must be the
166 # base URL from which the finished HTML is served.
167 #html_use_opensearch = ''
169 # This is the file name suffix for HTML files (e.g. ".xhtml").
170 #html_file_suffix = None
172 # Output file base name for HTML help builder.
173 htmlhelp_basename = 'MIT Kerberos'
177 # -- Options for LaTeX output --------------------------------------------------
179 # The paper size ('letter' or 'a4').
180 #latex_paper_size = 'letter'
182 # The font size ('10pt', '11pt' or '12pt').
183 #latex_font_size = '10pt'
185 # Grouping the document tree into LaTeX files. List of tuples
186 # (source start file, target name, title, author, documentclass [howto/manual]).
188 ('index', 'MIT Kerberos.tex', u'MIT Kerberos Documentation',
192 # The name of an image file (relative to this directory) to place at the top of
196 # For "manual" documents, if this is true, then toplevel headings are parts,
198 #latex_use_parts = False
200 # If true, show page references after internal links.
201 #latex_show_pagerefs = False
203 # If true, show URL addresses after external links.
204 #latex_show_urls = False
206 # Additional stuff for the LaTeX preamble.
209 # Documents to append as an appendix to all manuals.
210 #latex_appendices = []
212 # If false, no module index is generated.
213 #latex_domain_indices = True
216 # -- Options for manual page output --------------------------------------------
218 # One entry per manual page. List of tuples
219 # (source start file, name, description, authors, manual section).
221 ('krb_users/user_commands/kinit', 'kinit', u'obtain and cache Kerberos ticket-granting ticket', [u'MIT'], 1),
222 ('krb_users/user_commands/klist', 'klist', u'list cached Kerberos tickets', [u'MIT'], 1),
223 ('krb_users/user_commands/kdestroy', 'kdestroy', u'destroy Kerberos tickets', [u'MIT'], 1),
224 ('krb_users/user_commands/kswitch', 'kswitch', u'switch primary ticket cache', [u'MIT'], 1),
225 ('krb_users/user_commands/kpasswd', 'kpasswd', u'change a user\'s Kerberos password', [u'MIT'], 1),
226 ('krb_users/user_commands/kvno', 'kvno', u'print key version numbers of Kerberos principals', [u'MIT'], 1),
227 ('krb_users/user_commands/ksu', 'ksu', u'Kerberized super-user', [u'MIT'], 1),
228 ('krb_users/user_config/k5login', 'k5login', u'Kerberos V5 acl file for host access', [u'MIT'], 5),
229 ('krb_users/user_config/k5identity', 'k5identity', u'Kerberos V5 client principal selection rules', [u'MIT'], 5),
230 ('krb_admins/admin_commands/krb5kdc', 'krb5kdc', u'Kerberos V5 KDC', [u'MIT'], 8),
231 ('krb_admins/admin_commands/kadmin_local', 'kadmin', u'Kerberos V5 database administration program', [u'MIT'], 1),
232 ('krb_admins/admin_commands/kprop', 'kprop', u'propagate a Kerberos V5 principal database to a slave server', [u'MIT'], 8),
233 ('krb_admins/admin_commands/kproplog', 'kproplog', u'display the contents of the Kerberos principal update log', [u'MIT'], 8),
234 ('krb_admins/admin_commands/kpropd', 'kpropd', u'Kerberos V5 slave KDC update server', [u'MIT'], 8),
235 ('krb_admins/admin_commands/kdb5_util', 'kdb5_util', u'Kerberos database maintenance utility', [u'MIT'], 8),
236 ('krb_admins/admin_commands/ktutil', 'ktutil', u'Kerberos keytab file maintenance utility', [u'MIT'], 1),
237 ('krb_admins/admin_commands/k5srvutil', 'k5srvutil', u'host key table (keytab) manipulation utility', [u'MIT'], 1),
238 ('krb_admins/admin_commands/kadmind', 'kadmind', u'KADM5 administration server', [u'MIT'], 8),
239 ('krb_admins/admin_commands/kdb5_ldap_util', 'kdb5_ldap_util', u'Kerberos configuration utility', [u'MIT'], 8),
240 ('krb_admins/conf_files/krb5_conf', 'krb5.conf', u'Kerberos configuration file', [u'MIT'], 5),
241 ('krb_admins/conf_files/kdc_conf', 'kdc.conf', u'Kerberos V5 KDC configuration file', [u'MIT'], 5),
242 ('krb_users/user_commands/send-pr', 'krb5-send-pr', u'send problem report (PR) to a central support site', [u'MIT'], 1),
243 ('krb_users/user_commands/sclient', 'sclient', u'sample Kerberos version 5 client', [u'MIT'], 1),
244 ('krb_admins/admin_commands/sserver', 'sserver', u'sample Kerberos version 5 server', [u'MIT'], 8),