From eeb30513f8a8c5615e9c5d4f1a9feeef6c9635ab Mon Sep 17 00:00:00 2001 From: Gonzalo Casas Date: Wed, 18 Jan 2023 01:38:11 +0100 Subject: [PATCH] blacken docs config file --- docs/conf.py | 56 ++++++++++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index ab30962..b9e92b4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -4,38 +4,38 @@ import os extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.autosummary', - 'sphinx.ext.coverage', - 'sphinx.ext.doctest', - 'sphinx.ext.extlinks', - 'sphinx.ext.ifconfig', - 'sphinx.ext.napoleon', - 'sphinx.ext.todo', - 'sphinx.ext.viewcode', + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.coverage", + "sphinx.ext.doctest", + "sphinx.ext.extlinks", + "sphinx.ext.ifconfig", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", ] -if os.getenv('SPELLCHECK'): - extensions += 'sphinxcontrib.spelling', +if os.getenv("SPELLCHECK"): + extensions += ("sphinxcontrib.spelling",) spelling_show_suggestions = True - spelling_lang = 'en_US' + spelling_lang = "en_US" -source_suffix = '.rst' -master_doc = 'index' -project = 'roslibpy' -year = '2019' -author = 'Gramazio Kohler Research' -copyright = '{0}, {1}'.format(year, author) -version = release = '1.3.0' +source_suffix = ".rst" +master_doc = "index" +project = "roslibpy" +year = "2019" +author = "Gramazio Kohler Research" +copyright = "{0}, {1}".format(year, author) +version = release = "1.3.0" -pygments_style = 'trac' # Perhaps change to sphinx -templates_path = ['.'] +pygments_style = "trac" # Perhaps change to sphinx +templates_path = ["."] extlinks = { - 'issue': ('https://github.com/gramaziokohler/roslibpy/issues/%s', '#'), - 'pr': ('https://github.com/gramaziokohler/roslibpy/pull/%s', 'PR #'), + "issue": ("https://github.com/gramaziokohler/roslibpy/issues/%s", "#"), + "pr": ("https://github.com/gramaziokohler/roslibpy/pull/%s", "PR #"), } # on_rtd is whether we are on readthedocs.org -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' -html_theme = 'alabaster' +on_rtd = os.environ.get("READTHEDOCS", None) == "True" +html_theme = "alabaster" html_theme_options = { "description": "Python ROS Bridge library", "github_user": "gramaziokohler", @@ -44,12 +44,12 @@ } html_use_smartypants = True -html_last_updated_fmt = '%b %d, %Y' +html_last_updated_fmt = "%b %d, %Y" html_split_index = False html_sidebars = { - '**': ['about.html', 'navigation.html', 'searchbox.html'], + "**": ["about.html", "navigation.html", "searchbox.html"], } -html_short_title = '%s-%s' % (project, version) +html_short_title = "%s-%s" % (project, version) napoleon_use_ivar = True napoleon_use_rtype = False