Skip to content

Commit

Permalink
[trivial]: fix style of recently added docs files
Browse files Browse the repository at this point in the history
Signed-off-by: Sergio Correia <scorreia@redhat.com>
  • Loading branch information
sergio-correia authored and mpeters committed Jun 9, 2022
1 parent 66d7756 commit e12658b
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 37 deletions.
71 changes: 35 additions & 36 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@

# -- Project information -----------------------------------------------------

project = 'Keylime Documentation'
copyright = '2022, Keylime Developers'
author = 'Keylime Developers'
project = "Keylime Documentation"
copyright = "2022, Keylime Developers"
author = "Keylime Developers"

# The short X.Y version
version = ''
version = ""
# The full version, including alpha/beta/rc tags
release = '6.4.1'
release = "6.4.1"


# -- General configuration ---------------------------------------------------
Expand All @@ -39,29 +39,29 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.viewcode',
'sphinx.ext.autosectionlabel',
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.githubpages',
'sphinxcontrib.httpdomain',
'sphinx_tabs.tabs',
'sphinx-prompt',
'recommonmark',
'notfound.extension',
"sphinx.ext.viewcode",
"sphinx.ext.autosectionlabel",
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.githubpages",
"sphinxcontrib.httpdomain",
"sphinx_tabs.tabs",
"sphinx-prompt",
"recommonmark",
"notfound.extension",
]

# 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 master toctree document.
master_doc = 'index'
master_doc = "index"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand All @@ -73,7 +73,7 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None
Expand All @@ -84,8 +84,8 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
#html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'
# html_theme = 'alabaster'
html_theme = "sphinx_rtd_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
# documentation.
Expand All @@ -95,7 +95,7 @@
# 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"]

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand All @@ -111,7 +111,7 @@
# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'KeylimeDocumentationdoc'
htmlhelp_basename = "KeylimeDocumentationdoc"


# -- Options for LaTeX output ------------------------------------------------
Expand All @@ -120,15 +120,12 @@
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
Expand All @@ -138,19 +135,15 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'KeylimeDocumentation.tex', 'Keylime Documentation Documentation',
'Keylime Developers', 'manual'),
(master_doc, "KeylimeDocumentation.tex", "Keylime Documentation Documentation", "Keylime Developers", "manual"),
]


# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'keylimedocumentation', 'Keylime Documentation Documentation',
[author], 1)
]
man_pages = [(master_doc, "keylimedocumentation", "Keylime Documentation Documentation", [author], 1)]


# -- Options for Texinfo output ----------------------------------------------
Expand All @@ -159,9 +152,15 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'KeylimeDocumentation', 'Keylime Documentation Documentation',
author, 'KeylimeDocumentation', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"KeylimeDocumentation",
"Keylime Documentation Documentation",
author,
"KeylimeDocumentation",
"One line description of project.",
"Miscellaneous",
),
]


Expand All @@ -180,7 +179,7 @@
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
epub_exclude_files = ["search.html"]


# -- Extension configuration -------------------------------------------------
1 change: 0 additions & 1 deletion docs/setup.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
from setuptools import setup


# Configuration is in setup.cfg
setup()

0 comments on commit e12658b

Please sign in to comment.