1# -*- coding: utf-8 -*- 2# 3# Scapy documentation build configuration file. 4# 5# This file is execfile()d with the current directory set to its containing dir. 6# 7# The contents of this file are pickled, so don't put values in the namespace 8# that aren't pickleable (module imports are okay, they're removed automatically). 9# 10# All configuration values have a default value; values that are commented out 11# serve to show the default value. 12 13import sys, os 14 15# If your extensions are in another directory, add it here. If the directory 16# is relative to the documentation root, use os.path.abspath to make it 17# absolute, like shown here. 18#sys.path.append(os.path.abspath('some/directory')) 19 20# General configuration 21# --------------------- 22 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. 25extensions = [] 26 27# Add any paths that contain templates here, relative to this directory. 28templates_path = ['_templates'] 29 30# The suffix of source filenames. 31source_suffix = '.rst' 32 33# The master toctree document. 34master_doc = 'index' 35 36# General substitutions. 37project = 'Scapy' 38copyright = '2008, 2018 Philippe Biondi and the Scapy community' 39 40# The default replacements for |version| and |release|, also used in various 41# other places throughout the built documents. 42# 43# The short X.Y version. 44version = '2.3.3' 45# The full version, including alpha/beta/rc tags. 46release = '2.3.3-dev' 47 48# There are two options for replacing |today|: either, you set today to some 49# non-false value, then it is used: 50#today = '' 51# Else, today_fmt is used as the format for a strftime call. 52today_fmt = '%B %d, %Y' 53 54# List of documents that shouldn't be included in the build. 55#unused_docs = [] 56 57# List of directories, relative to source directories, that shouldn't be searched 58# for source files. 59#exclude_dirs = [] 60 61# The reST default role (used for this markup: `text`) to use for all documents. 62#default_role = None 63 64# If true, '()' will be appended to :func: etc. cross-reference text. 65#add_function_parentheses = True 66 67# If true, the current module name will be prepended to all description 68# unit titles (such as .. function::). 69#add_module_names = True 70 71# If true, sectionauthor and moduleauthor directives will be shown in the 72# output. They are ignored by default. 73#show_authors = False 74 75# The name of the Pygments (syntax highlighting) style to use. 76pygments_style = 'sphinx' 77 78 79# Options for HTML output 80# ----------------------- 81 82# Auto detect sphinx rtd. If set to True, if sphinx rtd is installed, it will be 83# automatically used. 84auto_rtd = True 85 86# The style sheet to use for HTML and HTML Help pages. A file of that name 87# must exist either in Sphinx' static/ path, or in one of the custom paths 88# given in html_static_path. 89html_style = 'default.css' 90 91# The name for this set of Sphinx documents. If None, it defaults to 92# "<project> v<release> documentation". 93#html_title = None 94 95# A shorter title for the navigation bar. Default is the same as html_title. 96#html_short_title = None 97 98# The name of an image file (within the static path) to place at the top of 99# the sidebar. 100#html_logo = None 101 102# The name of an image file (within the static path) to use as favicon of the 103# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 104# pixels large. 105#html_favicon = None 106 107# Add any paths that contain custom static files (such as style sheets) here, 108# relative to this directory. They are copied after the builtin static files, 109# so a file named "default.css" will overwrite the builtin "default.css". 110html_static_path = ['_static'] 111 112# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 113# using the given strftime format. 114html_last_updated_fmt = '%b %d, %Y' 115 116# If true, SmartyPants will be used to convert quotes and dashes to 117# typographically correct entities. 118#html_use_smartypants = True 119 120# Custom sidebar templates, maps document names to template names. 121#html_sidebars = {} 122 123# Additional templates that should be rendered to pages, maps page names to 124# template names. 125#html_additional_pages = {} 126 127# If false, no module index is generated. 128html_use_modindex = False 129 130# If false, no index is generated. 131#html_use_index = True 132 133# If true, the index is split into individual pages for each letter. 134#html_split_index = False 135 136# If true, the reST sources are included in the HTML build as _sources/<name>. 137#html_copy_source = True 138 139# If true, an OpenSearch description file will be output, and all pages will 140# contain a <link> tag referring to it. The value of this option must be the 141# base URL from which the finished HTML is served. 142#html_use_opensearch = '' 143 144# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 145#html_file_suffix = '' 146 147# Output file base name for HTML help builder. 148htmlhelp_basename = 'Scapydoc' 149 150 151# Options for LaTeX output 152# ------------------------ 153 154# The paper size ('letter' or 'a4'). 155latex_paper_size = 'a4' 156 157# The font size ('10pt', '11pt' or '12pt'). 158latex_font_size = '11pt' 159 160# Grouping the document tree into LaTeX files. List of tuples 161# (source start file, target name, title, author, document class [howto/manual]). 162latex_documents = [ 163 ('index', 'Scapy.tex', 'Scapy Documentation', 164 'Philippe Biondi and the Scapy community', 'manual'), 165] 166 167# The name of an image file (relative to this directory) to place at the top of 168# the title page. 169#latex_logo = None 170 171# For "manual" documents, if this is true, then toplevel headings are parts, 172# not chapters. 173#latex_use_parts = False 174 175# Additional stuff for the LaTeX preamble. 176#latex_preamble = '' 177 178# Documents to append as an appendix to all manuals. 179#latex_appendices = [] 180 181# If false, no module index is generated. 182latex_use_modindex = False 183 184############################################# 185######## END OF CONFIG FILE ######## 186######## DO NOT EDIT BELOW THIS LINE ######## 187############################################# 188 189### Performing detect tasks ### 190if auto_rtd: 191 try: 192 import sphinx_rtd_theme 193 del html_style 194 html_theme = "sphinx_rtd_theme" 195 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] 196 except: 197 pass 198