aboutsummaryrefslogtreecommitdiffstats
path: root/docs/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py143
1 files changed, 143 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 000000000..e1093e9ff
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,143 @@
1# -*- coding: utf-8 -*-
2#
3# Configuration file for the Sphinx documentation builder.
4#
5# This file does only contain a selection of the most common options. For a
6# full list see the documentation:
7# http://www.sphinx-doc.org/en/master/config
8
9# -- Path setup --------------------------------------------------------------
10
11# If extensions (or modules to document with autodoc) are in another directory,
12# add these directories to sys.path here. If the directory is relative to the
13# documentation root, use os.path.abspath to make it absolute, like shown here.
14#
15# import os
16# import sys
17# sys.path.insert(0, os.path.abspath('.'))
18
19# -- Project information -----------------------------------------------------
20
21project = 'Firejail'
22copyright = '2018, Firejail Authors'
23author = 'Firejail Authors'
24
25# The short X.Y version
26version = ''
27# The full version, including alpha/beta/rc tags
28release = '0.9.57'
29
30# -- General configuration ---------------------------------------------------
31
32# If your documentation needs a minimal Sphinx version, state it here.
33#
34# needs_sphinx = '1.0'
35
36# Add any Sphinx extension module names here, as strings. They can be
37# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
38# ones.
39extensions = []
40
41# Add any paths that contain templates here, relative to this directory.
42templates_path = ['_templates']
43
44# The suffix(es) of source filenames.
45# You can specify multiple suffix as a list of string:
46#
47# source_suffix = ['.rst', '.md']
48source_suffix = '.rst'
49
50# The master toctree document.
51master_doc = 'index'
52
53# The language for content autogenerated by Sphinx. Refer to documentation
54# for a list of supported languages.
55#
56# This is also used if you do content translation via gettext catalogs.
57# Usually you set "language" from the command line for these cases.
58language = None
59
60# List of patterns, relative to source directory, that match files and
61# directories to ignore when looking for source files.
62# This pattern also affects html_static_path and html_extra_path .
63exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
64
65# The name of the Pygments (syntax highlighting) style to use.
66pygments_style = 'sphinx'
67
68# -- Options for HTML output -------------------------------------------------
69
70# The theme to use for HTML and HTML Help pages. See the documentation for
71# a list of builtin themes.
72#
73html_theme = 'alabaster'
74
75# Theme options are theme-specific and customize the look and feel of a theme
76# further. For a list of options available for each theme, see the
77# documentation.
78#
79# html_theme_options = {}
80
81# Add any paths that contain custom static files (such as style sheets) here,
82# relative to this directory. They are copied after the builtin static files,
83# so a file named "default.css" will overwrite the builtin "default.css".
84html_static_path = ['_static']
85
86# Custom sidebar templates, must be a dictionary that maps document names
87# to template names.
88#
89# The default sidebars (for documents that don't match any pattern) are
90# defined by theme itself. Builtin themes are using these templates by
91# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
92# 'searchbox.html']``.
93#
94# html_sidebars = {}
95
96# -- Options for HTMLHelp output ---------------------------------------------
97
98# Output file base name for HTML help builder.
99htmlhelp_basename = 'Firejaildoc'
100
101# -- Options for LaTeX output ------------------------------------------------
102
103latex_elements = {
104 # The paper size ('letterpaper' or 'a4paper').
105 #
106 # 'papersize': 'letterpaper',
107
108 # The font size ('10pt', '11pt' or '12pt').
109 #
110 # 'pointsize': '10pt',
111
112 # Additional stuff for the LaTeX preamble.
113 #
114 # 'preamble': '',
115
116 # Latex figure (float) alignment
117 #
118 # 'figure_align': 'htbp',
119}
120
121# Grouping the document tree into LaTeX files. List of tuples
122# (source start file, target name, title,
123# author, documentclass [howto, manual, or own class]).
124latex_documents = [
125 (master_doc, 'Firejail.tex', 'Firejail Documentation', 'Firejail Authors',
126 'manual'),
127]
128
129# -- Options for manual page output ------------------------------------------
130
131# One entry per manual page. List of tuples
132# (source start file, name, description, authors, manual section).
133man_pages = [(master_doc, 'firejail', 'Firejail Documentation', [author], 1)]
134
135# -- Options for Texinfo output ----------------------------------------------
136
137# Grouping the document tree into Texinfo files. List of tuples
138# (source start file, target name, title, author,
139# dir menu entry, description, category)
140texinfo_documents = [
141 (master_doc, 'Firejail', 'Firejail Documentation', author, 'Firejail',
142 'One line description of project.', 'Miscellaneous'),
143]