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/stable/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+
20+ # -- Project information -----------------------------------------------------
21+
22+ project = 'PyTest Services'
23+ copyright = '2018, Mozilla Firefox Security Operations Team'
24+ author = 'Mozilla Firefox Security Operations Team'
25+
26+ # The short X.Y version
27+ version = ''
28+ # The full version, including alpha/beta/rc tags
29+ release = ''
30+
31+
32+ # -- General configuration ---------------------------------------------------
33+
34+ # If your documentation needs a minimal Sphinx version, state it here.
35+ #
36+ # needs_sphinx = '1.0'
37+
38+ # Add any Sphinx extension module names here, as strings. They can be
39+ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40+ # ones.
41+ extensions = [
42+ 'sphinx.ext.autodoc' ,
43+ 'sphinx.ext.doctest' ,
44+ 'sphinx.ext.coverage' ,
45+ 'sphinx.ext.githubpages' ,
46+ ]
47+
48+ # Add any paths that contain templates here, relative to this directory.
49+ templates_path = ['_templates' ]
50+
51+ # The suffix(es) of source filenames.
52+ # You can specify multiple suffix as a list of string:
53+ #
54+ # source_suffix = ['.rst', '.md']
55+ source_suffix = '.rst'
56+
57+ # The master toctree document.
58+ master_doc = 'index'
59+
60+ # The language for content autogenerated by Sphinx. Refer to documentation
61+ # for a list of supported languages.
62+ #
63+ # This is also used if you do content translation via gettext catalogs.
64+ # Usually you set "language" from the command line for these cases.
65+ language = None
66+
67+ # List of patterns, relative to source directory, that match files and
68+ # directories to ignore when looking for source files.
69+ # This pattern also affects html_static_path and html_extra_path .
70+ exclude_patterns = ['_build' , 'Thumbs.db' , '.DS_Store' ]
71+
72+ # The name of the Pygments (syntax highlighting) style to use.
73+ pygments_style = 'sphinx'
74+
75+
76+ # -- Options for HTML output -------------------------------------------------
77+
78+ # The theme to use for HTML and HTML Help pages. See the documentation for
79+ # a list of builtin themes.
80+ #
81+ html_theme = 'alabaster'
82+
83+ # Theme options are theme-specific and customize the look and feel of a theme
84+ # further. For a list of options available for each theme, see the
85+ # documentation.
86+ #
87+ # html_theme_options = {}
88+
89+ # Add any paths that contain custom static files (such as style sheets) here,
90+ # relative to this directory. They are copied after the builtin static files,
91+ # so a file named "default.css" will overwrite the builtin "default.css".
92+ html_static_path = ['_static' ]
93+
94+ # Custom sidebar templates, must be a dictionary that maps document names
95+ # to template names.
96+ #
97+ # The default sidebars (for documents that don't match any pattern) are
98+ # defined by theme itself. Builtin themes are using these templates by
99+ # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
100+ # 'searchbox.html']``.
101+ #
102+ # html_sidebars = {}
103+
104+
105+ # -- Options for HTMLHelp output ---------------------------------------------
106+
107+ # Output file base name for HTML help builder.
108+ htmlhelp_basename = 'PyTestServicesdoc'
109+
110+
111+ # -- Options for LaTeX output ------------------------------------------------
112+
113+ latex_elements = {
114+ # The paper size ('letterpaper' or 'a4paper').
115+ #
116+ # 'papersize': 'letterpaper',
117+
118+ # The font size ('10pt', '11pt' or '12pt').
119+ #
120+ # 'pointsize': '10pt',
121+
122+ # Additional stuff for the LaTeX preamble.
123+ #
124+ # 'preamble': '',
125+
126+ # Latex figure (float) alignment
127+ #
128+ # 'figure_align': 'htbp',
129+ }
130+
131+ # Grouping the document tree into LaTeX files. List of tuples
132+ # (source start file, target name, title,
133+ # author, documentclass [howto, manual, or own class]).
134+ latex_documents = [
135+ (master_doc , 'PyTestServices.tex' , 'PyTest Services Documentation' ,
136+ 'Mozilla Firefox Security Operations Team' , 'manual' ),
137+ ]
138+
139+
140+ # -- Options for manual page output ------------------------------------------
141+
142+ # One entry per manual page. List of tuples
143+ # (source start file, name, description, authors, manual section).
144+ man_pages = [
145+ (master_doc , 'pytestservices' , 'PyTest Services Documentation' ,
146+ [author ], 1 )
147+ ]
148+
149+
150+ # -- Options for Texinfo output ----------------------------------------------
151+
152+ # Grouping the document tree into Texinfo files. List of tuples
153+ # (source start file, target name, title, author,
154+ # dir menu entry, description, category)
155+ texinfo_documents = [
156+ (master_doc , 'PyTestServices' , 'PyTest Services Documentation' ,
157+ author , 'PyTestServices' , 'One line description of project.' ,
158+ 'Miscellaneous' ),
159+ ]
160+
161+
162+ # -- Extension configuration -------------------------------------------------
0 commit comments