1 # -*- coding: utf-8 -*-
3 # FreeRADIUS documentation build configuration file, created by
4 # sphinx-quickstart on Tue May 18 13:26:39 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.append(os.path.abspath('.'))
21 # -- General configuration -----------------------------------------------------
23 # Add any Sphinx extension module names here, as strings. They can be extensions
24 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
25 extensions = ['sphinx.ext.todo', 'rst2pdf.pdfbuilder']
27 # Add any paths that contain templates here, relative to this directory.
28 templates_path = ['_templates']
30 # The suffix of source filenames.
31 source_suffix = '.rst'
33 # The encoding of source files.
34 #source_encoding = 'utf-8'
36 # The master toctree document.
39 # General information about the project.
40 project = u'FreeRADIUS'
41 copyright = u'2010, Alan DeKok, Peter Nixon'
43 # The version info for the project you're documenting, acts as replacement for
44 # |version| and |release|, also used in various other places throughout the
47 # The short X.Y version.
49 # The full version, including alpha/beta/rc tags.
52 # The language for content autogenerated by Sphinx. Refer to documentation
53 # for a list of supported languages.
56 # There are two options for replacing |today|: either, you set today to some
57 # non-false value, then it is used:
59 # Else, today_fmt is used as the format for a strftime call.
60 #today_fmt = '%B %d, %Y'
62 # List of documents that shouldn't be included in the build.
65 # List of directories, relative to source directory, that shouldn't be searched
67 exclude_trees = ['_build']
69 # The reST default role (used for this markup: `text`) to use for all documents.
72 # If true, '()' will be appended to :func: etc. cross-reference text.
73 #add_function_parentheses = True
75 # If true, the current module name will be prepended to all description
76 # unit titles (such as .. function::).
77 #add_module_names = True
79 # If true, sectionauthor and moduleauthor directives will be shown in the
80 # output. They are ignored by default.
83 # The name of the Pygments (syntax highlighting) style to use.
84 pygments_style = 'sphinx'
86 # A list of ignored prefixes for module index sorting.
87 #modindex_common_prefix = []
90 # -- Options for HTML output ---------------------------------------------------
92 # The theme to use for HTML and HTML Help pages. Major themes that come with
93 # Sphinx are currently 'default' and 'sphinxdoc'.
94 html_theme = 'default'
96 # Theme options are theme-specific and customize the look and feel of a theme
97 # further. For a list of options available for each theme, see the
99 #html_theme_options = {}
101 # Add any paths that contain custom themes here, relative to this directory.
102 #html_theme_path = []
104 # The name for this set of Sphinx documents. If None, it defaults to
105 # "<project> v<release> documentation".
108 # A shorter title for the navigation bar. Default is the same as html_title.
109 #html_short_title = None
111 # The name of an image file (relative to this directory) to place at the top
115 # The name of an image file (within the static path) to use as favicon of the
116 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
120 # Add any paths that contain custom static files (such as style sheets) here,
121 # relative to this directory. They are copied after the builtin static files,
122 # so a file named "default.css" will overwrite the builtin "default.css".
123 html_static_path = ['_static']
125 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
126 # using the given strftime format.
127 #html_last_updated_fmt = '%b %d, %Y'
129 # If true, SmartyPants will be used to convert quotes and dashes to
130 # typographically correct entities.
131 #html_use_smartypants = True
133 # Custom sidebar templates, maps document names to template names.
136 # Additional templates that should be rendered to pages, maps page names to
138 #html_additional_pages = {}
140 # If false, no module index is generated.
141 #html_use_modindex = True
143 # If false, no index is generated.
144 #html_use_index = True
146 # If true, the index is split into individual pages for each letter.
147 #html_split_index = False
149 # If true, links to the reST sources are added to the pages.
150 #html_show_sourcelink = True
152 # If true, an OpenSearch description file will be output, and all pages will
153 # contain a <link> tag referring to it. The value of this option must be the
154 # base URL from which the finished HTML is served.
155 #html_use_opensearch = ''
157 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
158 #html_file_suffix = ''
160 # Output file base name for HTML help builder.
161 htmlhelp_basename = 'FreeRADIUSdoc'
164 # -- Options for LaTeX output --------------------------------------------------
166 # The paper size ('letter' or 'a4').
167 #latex_paper_size = 'letter'
169 # The font size ('10pt', '11pt' or '12pt').
170 #latex_font_size = '10pt'
172 # Grouping the document tree into LaTeX files. List of tuples
173 # (source start file, target name, title, author, documentclass [howto/manual]).
175 ('index', 'FreeRADIUS.tex', u'FreeRADIUS Documentation',
176 u'Alan DeKok, Peter Nixon', 'manual'),
179 # The name of an image file (relative to this directory) to place at the top of
183 # For "manual" documents, if this is true, then toplevel headings are parts,
185 #latex_use_parts = False
187 # Additional stuff for the LaTeX preamble.
190 # Documents to append as an appendix to all manuals.
191 #latex_appendices = []
193 # If false, no module index is generated.
194 #latex_use_modindex = True
197 # -- Options for PDF output --------------------------------------------------
199 # Grouping the document tree into PDF files. List of tuples
200 # (source start file, target name, title, author, options).
202 # If there is more than one author, separate them with \\.
203 # For example: r'Guido van Rossum\\Fred L. Drake, Jr., editor'
205 # The options element is a dictionary that lets you override
206 # this config per-document.
208 # ('index', u'MyProject', u'My Project', u'Author Name',
209 # dict(pdf_compressed = True))
210 # would mean that specific document would be compressed
211 # regardless of the global pdf_compressed setting.
215 ('index', 'FreeRADIUS', u'FreeRADIUS Documentation', u'Alan DeKok, Peter Nixon'),
218 # A comma-separated list of custom stylesheets. Example:
219 #pdf_stylesheets = ['sphinx','kerning','a4']
220 pdf_stylesheets = ['default','kerning','a4']
222 # Create a compressed PDF
223 # Use True/False or 1/0
224 # Example: compressed=True
225 pdf_compressed = True
227 # A colon-separated list of folders to search for fonts. Example:
228 # pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/']
230 # Language to be used for hyphenation support
231 #pdf_language = "en_US"
233 # Mode for literal blocks wider than the frame. Can be
234 # overflow, shrink or truncate
235 pdf_fit_mode = "shrink"
237 # Section level that forces a break page.
238 # For example: 1 means top-level sections start in a new page
242 # When a section starts in a new page, force it to be 'even', 'odd',
244 pdf_breakside = 'any'
246 # Insert footnotes where they are defined instead of
248 #pdf_inline_footnotes = True
250 # verbosity level. 0 1 or 2
253 # If false, no index is generated.
256 # If false, no modindex is generated.
257 pdf_use_modindex = False
259 # If false, no coverpage is generated.
260 pdf_use_coverpage = True
262 # Name of the cover page template to use
263 #pdf_cover_template = 'cover.tmpl'
265 # Documents to append as an appendix to all manuals.
268 # Enable experimental feature to split table cells. Use it
269 # if you get "DelayedTable too big" errors
270 #pdf_splittables = False
272 # Set the default DPI for images
273 #pdf_default_dpi = 72
275 # Enable rst2pdf extension modules (default is empty list)
276 # you need vectorpdf for better sphinx's graphviz support
277 #pdf_extensions = ['vectorpdf']
279 # Page template name for "regular" pages
280 #pdf_page_template = 'cutePage'