Merge pull request #112 from minos-framework/restyled/issue-1-remove-duplicate-config-packages

Restyle #1 - Remove duplicate config from packages

Author: Sergio García Prado

packages/core/minos-microservice-aggregate/docs/conf.py

@@ -19,9 +19,14 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
 
-from minos import aggregate
+sys.path.insert(0, os.path.abspath(".."))
+
+import sphinx_rtd_theme
+
+from minos import (
+    aggregate,
+)
 
 # -- General configuration ---------------------------------------------
 
@@ -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 Microservice Aggregate'
+project = "Minos Microservice Aggregate"
 copyright = "2021, Clariteia"
 author = "Clariteia Devs"
 
@@ -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
@@ -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
@@ -119,7 +123,7 @@
 # -- Options for HTMLHelp output ---------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'minosdoc'
+htmlhelp_basename = "minosdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------
@@ -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',
@@ -146,21 +147,15 @@
 # (source start file, target name, title, author, documentclass
 # [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'minos.tex',
-     'Minos Microservice Aggregate Documentation',
-     'Clariteia Devs', 'manual'),
+    (master_doc, "minos.tex", "Minos Microservice Aggregate 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 Microservice Aggregate Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "minos", "Minos Microservice Aggregate Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------
@@ -169,12 +164,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'minos',
-     'Minos Microservice Aggregate Documentation',
-     author,
-     'minos',
-     'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "minos",
+        "Minos Microservice Aggregate Documentation",
+        author,
+        "minos",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # "apidoc" extension

packages/core/minos-microservice-common/docs/conf.py

@@ -19,9 +19,14 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
 
-from minos import common
+sys.path.insert(0, os.path.abspath(".."))
+
+import sphinx_rtd_theme
+
+from minos import (
+    common,
+)
 
 # -- General configuration ---------------------------------------------
 
@@ -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 Microservice Common'
+project = "Minos Microservice Common"
 copyright = "2021, Clariteia"
 author = "Clariteia Devs"
 
@@ -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
@@ -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
@@ -119,7 +123,7 @@
 # -- Options for HTMLHelp output ---------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'minosdoc'
+htmlhelp_basename = "minosdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------
@@ -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',
@@ -146,21 +147,15 @@
 # (source start file, target name, title, author, documentclass
 # [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'minos.tex',
-     'Minos Microservice Common Documentation',
-     'Clariteia Devs', 'manual'),
+    (master_doc, "minos.tex", "Minos Microservice Common 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 Microservice Common Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "minos", "Minos Microservice Common Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------
@@ -169,12 +164,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'minos',
-     'Minos Microservice Common Documentation',
-     author,
-     'minos',
-     'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "minos",
+        "Minos Microservice Common Documentation",
+        author,
+        "minos",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # "apidoc" extension
@@ -193,9 +191,7 @@
     "--force",
     "--implicit-namespaces",
 ]
-apidoc_excluded_paths = [
-    '../minos/common/testing.py'
-]
+apidoc_excluded_paths = ["../minos/common/testing.py"]
 # "autodoc typehints" extension
 
 set_type_checking_flag = True