style: apply black and isort
This commit is contained in:
Gabriel Ferreira
@@ -20,21 +20,22 @@
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
import sys, os
|
||||
import os
|
||||
import sys
|
||||
|
||||
# To change default code-block format in Latex to footnotesize (8pt)
|
||||
# Tip from https://stackoverflow.com/questions/9899283/how-do-you-change-the-code-example-font-size-in-latex-pdf-output-with-sphinx/9955928
|
||||
# Note: sizes are \footnotesize (8pt), \small (9pt), and \normalsize (10pt).
|
||||
|
||||
#from sphinx.highlighting import PygmentsBridge
|
||||
#from pygments.formatters.latex import LatexFormatter
|
||||
# from sphinx.highlighting import PygmentsBridge
|
||||
# from pygments.formatters.latex import LatexFormatter
|
||||
#
|
||||
#class CustomLatexFormatter(LatexFormatter):
|
||||
# class CustomLatexFormatter(LatexFormatter):
|
||||
# def __init__(self, **options):
|
||||
# super(CustomLatexFormatter, self).__init__(**options)
|
||||
# self.verboptions = r"formatcom=\footnotesize"
|
||||
#
|
||||
#PygmentsBridge.latex_formatter = CustomLatexFormatter
|
||||
# PygmentsBridge.latex_formatter = CustomLatexFormatter
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
@@ -45,37 +46,37 @@ import sys, os
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = ['sphinx.ext.imgmath']
|
||||
extensions = ["sphinx.ext.imgmath"]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
templates_path = ["_templates"]
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
# source_suffix = ['.rst', '.md']
|
||||
source_suffix = '.rst'
|
||||
source_suffix = ".rst"
|
||||
|
||||
# The encoding of source files.
|
||||
#
|
||||
# source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
master_doc = "index"
|
||||
|
||||
# General information about the project.
|
||||
project = u'ns-3 project'
|
||||
copyright = u'2006-2019, ns-3 project'
|
||||
#author = u'test'
|
||||
project = "ns-3 project"
|
||||
copyright = "2006-2019, ns-3 project"
|
||||
# author = u'test'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = u'ns-3-dev'
|
||||
version = "ns-3-dev"
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = u'ns-3-dev'
|
||||
release = "ns-3-dev"
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
@@ -96,7 +97,7 @@ language = None
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# These patterns also affect html_static_path and html_extra_path
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
@@ -118,7 +119,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
# show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
pygments_style = "sphinx"
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
# modindex_common_prefix = []
|
||||
@@ -135,7 +136,7 @@ todo_include_todos = False
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'ns3_html_theme'
|
||||
html_theme = "ns3_html_theme"
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
@@ -144,18 +145,18 @@ html_theme = 'ns3_html_theme'
|
||||
# html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
html_theme_path = ['../..']
|
||||
html_theme_path = ["../.."]
|
||||
|
||||
# The name for this set of Sphinx documents.
|
||||
# "<project> v<release> documentation" by default.
|
||||
#
|
||||
# html_title = 'est vtest'
|
||||
html_title = 'Model Library'
|
||||
html_title = "Model Library"
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#
|
||||
# html_short_title = None
|
||||
html_short_title = 'Models'
|
||||
html_short_title = "Models"
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
@@ -171,7 +172,7 @@ html_short_title = 'Models'
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
html_static_path = ["_static"]
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
@@ -183,7 +184,7 @@ html_static_path = ['_static']
|
||||
# bottom, using the given strftime format.
|
||||
# The empty string is equivalent to '%b %d, %Y'.
|
||||
#
|
||||
html_last_updated_fmt = '%b %d, %Y %H:%M'
|
||||
html_last_updated_fmt = "%b %d, %Y %H:%M"
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
@@ -251,7 +252,7 @@ html_last_updated_fmt = '%b %d, %Y %H:%M'
|
||||
# html_search_scorer = 'scorer.js'
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'ns-3doc'
|
||||
htmlhelp_basename = "ns-3doc"
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
@@ -259,11 +260,9 @@ latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#
|
||||
# VerbatimBorderColor: make the box around code samples blend into the background
|
||||
@@ -276,10 +275,10 @@ latex_elements = {
|
||||
# See above to change the font size of verbatim code blocks
|
||||
#
|
||||
# 'preamble': '',
|
||||
'preamble': u'''\\usepackage{amssymb}
|
||||
"preamble": """\\usepackage{amssymb}
|
||||
\\definecolor{VerbatimBorderColor}{rgb}{1,1,1}
|
||||
\\renewcommand{\\sphinxcode}[1]{\\texttt{\\small{#1}}}
|
||||
'''
|
||||
"""
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
@@ -289,14 +288,13 @@ latex_elements = {
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
('index', 'ns-3-model-library.tex', u'ns-3 Model Library',
|
||||
u'ns-3 project', 'manual'),
|
||||
("index", "ns-3-model-library.tex", "ns-3 Model Library", "ns-3 project", "manual"),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#
|
||||
latex_logo = '../../ns3_html_theme/static/ns-3.png'
|
||||
latex_logo = "../../ns3_html_theme/static/ns-3.png"
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#
|
||||
@@ -325,10 +323,7 @@ latex_logo = '../../ns3_html_theme/static/ns-3.png'
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'ns-3-model-library', u'ns-3 Model Library',
|
||||
[u'ns-3 project'], 1)
|
||||
]
|
||||
man_pages = [("index", "ns-3-model-library", "ns-3 Model Library", ["ns-3 project"], 1)]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#
|
||||
@@ -336,11 +331,11 @@ man_pages = [
|
||||
|
||||
# -- Options for texinfo output ---------------------------------------
|
||||
|
||||
#texinfo_documents = [
|
||||
# texinfo_documents = [
|
||||
# (master_doc, 'test', u'test Documentation',
|
||||
# author, 'test', 'One line description of project.',
|
||||
# 'Miscellaneous'),
|
||||
#]
|
||||
# ]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#
|
||||
|
||||
Reference in New Issue
Block a user