Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 28 additions & 30 deletions packages/plugins/minos-rest-aiohttp/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,14 @@
#
import os
import sys
sys.path.insert(0, os.path.abspath('..'))

from minos import plugins
sys.path.insert(0, os.path.abspath(".."))

import sphinx_rtd_theme

from minos import (
plugins,
)

# -- General configuration ---------------------------------------------

Expand All @@ -32,29 +37,28 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.

import sphinx_rtd_theme

extensions = [
"sphinxcontrib.apidoc",
'sphinx.ext.autodoc',
"sphinx.ext.autodoc",
"sphinx_autodoc_typehints",
"sphinx.ext.viewcode",
"sphinx_rtd_theme",
"m2r2",
]
# 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", ".md"]

# The master toctree document.
master_doc = 'index'
master_doc = "index"

# General information about the project.
project = 'Minos Rest Aiohttp'
project = "Minos Rest Aiohttp"
copyright = "2021, Clariteia"
author = "Clariteia Devs"

Expand All @@ -77,10 +81,10 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to 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 = 'sphinx'
pygments_style = "sphinx"

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
Expand All @@ -92,7 +96,7 @@
# a list of builtin themes.
#

html_theme = 'sphinx_rtd_theme'
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
Expand All @@ -113,13 +117,13 @@
# 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"]


# -- Options for HTMLHelp output ---------------------------------------

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


# -- Options for LaTeX output ------------------------------------------
Expand All @@ -128,15 +132,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 @@ -146,21 +147,15 @@
# (source start file, target name, title, author, documentclass
# [howto, manual, or own class]).
latex_documents = [
(master_doc, 'minos.tex',
'Minos Rest Aiohttp Documentation',
'Clariteia Devs', 'manual'),
(master_doc, "minos.tex", "Minos Rest Aiohttp Documentation", "Clariteia Devs", "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, 'minos',
'Minos Rest Aiohttp Documentation',
[author], 1)
]
man_pages = [(master_doc, "minos", "Minos Rest Aiohttp Documentation", [author], 1)]


# -- Options for Texinfo output ----------------------------------------
Expand All @@ -169,12 +164,15 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'minos',
'Minos Rest Aiohttp Documentation',
author,
'minos',
'One line description of project.',
'Miscellaneous'),
(
master_doc,
"minos",
"Minos Rest Aiohttp Documentation",
author,
"minos",
"One line description of project.",
"Miscellaneous",
),
]

# "apidoc" extension
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ def test_something(self):
self.assertEqual(True, True)


if __name__ == '__main__':
if __name__ == "__main__":
unittest.main()