🔧 Ruff format python files within docs folder (sphinx-doc#12139)

Remove `docs` files from the `exclude` list, and also add the `preview = false` format config, which is shown to reduce diffs to the current code base

Author: chrisjsewell

.ruff.toml

@@ -423,9 +423,9 @@ forced-separate = [
 ]
 
 [format]
+preview = true
 quote-style = "single"
 exclude = [
-    "doc/**/*",
     "sphinx/__init__.py",
     "sphinx/addnodes.py",
     "sphinx/application.py",

doc/conf.py

@@ -8,11 +8,17 @@
 
 os.environ['SPHINX_AUTODOC_RELOAD_MODULES'] = '1'
 
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo',
-              'sphinx.ext.autosummary', 'sphinx.ext.extlinks',
-              'sphinx.ext.intersphinx',
-              'sphinx.ext.viewcode', 'sphinx.ext.inheritance_diagram',
-              'sphinx.ext.coverage']
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.todo',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.extlinks',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.inheritance_diagram',
+    'sphinx.ext.coverage',
+]
 coverage_statistics_to_report = coverage_statistics_to_stdout = True
 templates_path = ['_templates']
 exclude_patterns = ['_build']
@@ -49,40 +55,47 @@
 epub_scheme = 'url'
 epub_identifier = epub_publisher
 epub_pre_files = [('index.xhtml', 'Welcome')]
-epub_post_files = [('usage/installation.xhtml', 'Installing Sphinx'),
-                   ('develop.xhtml', 'Sphinx development')]
-epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js',
-                      '_static/searchtools.js',
-                      '_static/sphinx_highlight.js',
-                      '_static/basic.css',
-                      '_static/language_data.js',
-                      'search.html', '_static/websupport.js']
+epub_post_files = [
+    ('usage/installation.xhtml', 'Installing Sphinx'),
+    ('develop.xhtml', 'Sphinx development'),
+]
+epub_exclude_files = [
+    '_static/opensearch.xml',
+    '_static/doctools.js',
+    '_static/searchtools.js',
+    '_static/sphinx_highlight.js',
+    '_static/basic.css',
+    '_static/language_data.js',
+    'search.html',
+    '_static/websupport.js',
+]
 epub_fix_images = False
 epub_max_image_width = 0
 epub_show_urls = 'inline'
 epub_use_index = False
 epub_description = 'Sphinx documentation generator system manual'
 
-latex_documents = [('index', 'sphinx.tex', 'Sphinx Documentation',
-                    'the Sphinx developers', 'manual', 1)]
+latex_documents = [
+    ('index', 'sphinx.tex', 'Sphinx Documentation', 'the Sphinx developers', 'manual', 1)
+]
 latex_logo = '_static/sphinx.png'
 latex_elements = {
     'fontenc': r'\usepackage[LGR,X2,T1]{fontenc}',
-    'passoptionstopackages': r'''
+    'passoptionstopackages': r"""
 \PassOptionsToPackage{svgnames}{xcolor}
-''',
-    'preamble': r'''
+""",
+    'preamble': r"""
 \DeclareUnicodeCharacter{229E}{\ensuremath{\boxplus}}
 \setcounter{tocdepth}{3}%    depth of what main TOC shows (3=subsubsection)
 \setcounter{secnumdepth}{1}% depth of section numbering
 \setlength{\tymin}{2cm}%     avoid too cramped table columns
-''',
+""",
     # fix missing index entry due to RTD doing only once pdflatex after makeindex
-    'printindex': r'''
+    'printindex': r"""
 \IfFileExists{\jobname.ind}
              {\footnotesize\raggedright\printindex}
              {\begin{sphinxtheindex}\end{sphinxtheindex}}
-''',
+""",
 }
 latex_show_urls = 'footnote'
 latex_use_xindy = True
@@ -92,30 +105,46 @@
 autodoc_member_order = 'groupwise'
 autosummary_generate = False
 todo_include_todos = True
-extlinks = {'duref': ('https://docutils.sourceforge.io/docs/ref/rst/'
-                      'restructuredtext.html#%s', '%s'),
-            'durole': ('https://docutils.sourceforge.io/docs/ref/rst/'
-                       'roles.html#%s', '%s'),
-            'dudir': ('https://docutils.sourceforge.io/docs/ref/rst/'
-                      'directives.html#%s', '%s')}
+extlinks = {
+    'duref': (
+        'https://docutils.sourceforge.io/docs/ref/rst/' 'restructuredtext.html#%s',
+        '%s',
+    ),
+    'durole': ('https://docutils.sourceforge.io/docs/ref/rst/' 'roles.html#%s', '%s'),
+    'dudir': ('https://docutils.sourceforge.io/docs/ref/rst/' 'directives.html#%s', '%s'),
+}
 
 man_pages = [
-    ('index', 'sphinx-all', 'Sphinx documentation generator system manual',
-     'the Sphinx developers', 1),
-    ('man/sphinx-build', 'sphinx-build', 'Sphinx documentation generator tool',
-     '', 1),
-    ('man/sphinx-quickstart', 'sphinx-quickstart', 'Sphinx documentation '
-     'template generator', '', 1),
-    ('man/sphinx-apidoc', 'sphinx-apidoc', 'Sphinx API doc generator tool',
-     '', 1),
-    ('man/sphinx-autogen', 'sphinx-autogen', 'Generate autodoc stub pages',
-     '', 1),
+    (
+        'index',
+        'sphinx-all',
+        'Sphinx documentation generator system manual',
+        'the Sphinx developers',
+        1,
+    ),
+    ('man/sphinx-build', 'sphinx-build', 'Sphinx documentation generator tool', '', 1),
+    (
+        'man/sphinx-quickstart',
+        'sphinx-quickstart',
+        'Sphinx documentation ' 'template generator',
+        '',
+        1,
+    ),
+    ('man/sphinx-apidoc', 'sphinx-apidoc', 'Sphinx API doc generator tool', '', 1),
+    ('man/sphinx-autogen', 'sphinx-autogen', 'Generate autodoc stub pages', '', 1),
 ]
 
 texinfo_documents = [
-    ('index', 'sphinx', 'Sphinx Documentation', 'the Sphinx developers',
-     'Sphinx', 'The Sphinx documentation builder.', 'Documentation tools',
-     1),
+    (
+        'index',
+        'sphinx',
+        'Sphinx Documentation',
+        'the Sphinx developers',
+        'Sphinx',
+        'The Sphinx documentation builder.',
+        'Documentation tools',
+        1,
+    ),
 ]
 
 intersphinx_mapping = {
@@ -129,7 +158,10 @@
 gettext_compact = False
 
 nitpick_ignore = {
-    ('cpp:class', 'template<typename TOuter> template<typename TInner> Wrapper::Outer<TOuter>::Inner'),  # NoQA: E501
+    (
+        'cpp:class',
+        'template<typename TOuter> template<typename TInner> Wrapper::Outer<TOuter>::Inner',
+    ),  # NoQA: E501
     ('cpp:identifier', 'MyContainer'),
     ('js:func', 'SomeError'),
     ('js:func', 'number'),
@@ -213,13 +245,13 @@ def parse_event(env, sig, signode):
 def linkify_issues_in_changelog(app, docname, source):
     """Linkify issue references like #123 in changelog to GitHub."""
     if docname == 'changes':
-        changelog_path = os.path.join(os.path.dirname(__file__), "../CHANGES.rst")
+        changelog_path = os.path.join(os.path.dirname(__file__), '../CHANGES.rst')
         # this path trickery is needed because this script can
         # be invoked with different working directories:
         # * running make in docs/
         # * running tox -e docs in the repo root dir
 
-        with open(changelog_path, encoding="utf-8") as f:
+        with open(changelog_path, encoding='utf-8') as f:
             changelog = f.read()
 
         def linkify(match):
@@ -234,12 +266,16 @@ def linkify(match):
 def setup(app):
     from sphinx.ext.autodoc import cut_lines
     from sphinx.util.docfields import GroupedField
+
     app.connect('autodoc-process-docstring', cut_lines(4, what=['module']))
     app.connect('source-read', linkify_issues_in_changelog)
-    app.add_object_type('confval', 'confval',
-                        objname='configuration value',
-                        indextemplate='pair: %s; configuration value')
-    fdesc = GroupedField('parameter', label='Parameters',
-                         names=['param'], can_collapse=True)
-    app.add_object_type('event', 'event', 'pair: %s; event', parse_event,
-                        doc_field_types=[fdesc])
+    app.add_object_type(
+        'confval',
+        'confval',
+        objname='configuration value',
+        indextemplate='pair: %s; configuration value',
+    )
+    fdesc = GroupedField('parameter', label='Parameters', names=['param'], can_collapse=True)
+    app.add_object_type(
+        'event', 'event', 'pair: %s; event', parse_event, doc_field_types=[fdesc]
+    )

doc/development/tutorials/examples/autodoc_intenum.py

@@ -19,9 +19,9 @@ class IntEnumDocumenter(ClassDocumenter):
     option_spec['hex'] = bool_option
 
     @classmethod
-    def can_document_member(cls,
-                            member: Any, membername: str,
-                            isattr: bool, parent: Any) -> bool:
+    def can_document_member(
+        cls, member: Any, membername: str, isattr: bool, parent: Any
+    ) -> bool:
         try:
             return issubclass(member, IntEnum)
         except TypeError:
@@ -31,11 +31,11 @@ def add_directive_header(self, sig: str) -> None:
         super().add_directive_header(sig)
         self.add_line('   :final:', self.get_sourcename())
 
-    def add_content(self,
-                    more_content: StringList | None,
-                    no_docstring: bool = False,
-                    ) -> None:
-
+    def add_content(
+        self,
+        more_content: StringList | None,
+        no_docstring: bool = False,
+    ) -> None:
         super().add_content(more_content, no_docstring)
 
         source_name = self.get_sourcename()
@@ -48,8 +48,7 @@ def add_content(self,
             if use_hex:
                 the_member_value = hex(the_member_value)
 
-            self.add_line(
-                f"**{the_member_name}**: {the_member_value}", source_name)
+            self.add_line(f'**{the_member_name}**: {the_member_value}', source_name)
             self.add_line('', source_name)
 
 

doc/development/tutorials/examples/helloworld.py

@@ -3,14 +3,13 @@
 
 
 class HelloWorld(Directive):
-
     def run(self):
         paragraph_node = nodes.paragraph(text='Hello World!')
         return [paragraph_node]
 
 
 def setup(app):
-    app.add_directive("helloworld", HelloWorld)
+    app.add_directive('helloworld', HelloWorld)
 
     return {
         'version': '0.1',

doc/development/tutorials/examples/recipe.py

@@ -25,8 +25,7 @@ def handle_signature(self, sig, signode):
     def add_target_and_index(self, name_cls, sig, signode):
         signode['ids'].append('recipe' + '-' + sig)
         if 'contains' in self.options:
-            ingredients = [
-                x.strip() for x in self.options.get('contains').split(',')]
+            ingredients = [x.strip() for x in self.options.get('contains').split(',')]
 
             recipes = self.env.get_domain('recipe')
             recipes.add_recipe(sig, ingredients)
@@ -42,9 +41,10 @@ class IngredientIndex(Index):
     def generate(self, docnames=None):
         content = defaultdict(list)
 
-        recipes = {name: (dispname, typ, docname, anchor)
-                   for name, dispname, typ, docname, anchor, _
-                   in self.domain.get_objects()}
+        recipes = {
+            name: (dispname, typ, docname, anchor)
+            for name, dispname, typ, docname, anchor, _ in self.domain.get_objects()
+        }
         recipe_ingredients = self.domain.data['recipe_ingredients']
         ingredient_recipes = defaultdict(list)
 
@@ -60,8 +60,7 @@ def generate(self, docnames=None):
         for ingredient, recipe_names in ingredient_recipes.items():
             for recipe_name in recipe_names:
                 dispname, typ, docname, anchor = recipes[recipe_name]
-                content[ingredient].append(
-                    (dispname, 0, docname, anchor, docname, '', typ))
+                content[ingredient].append((dispname, 0, docname, anchor, docname, '', typ))
 
         # convert the dict to the sorted list of tuples expected
         content = sorted(content.items())
@@ -88,8 +87,15 @@ def generate(self, docnames=None):
         #
         # name, subtype, docname, anchor, extra, qualifier, description
         for _name, dispname, typ, docname, anchor, _priority in recipes:
-            content[dispname[0].lower()].append(
-                (dispname, 0, docname, anchor, docname, '', typ))
+            content[dispname[0].lower()].append((
+                dispname,
+                0,
+                docname,
+                anchor,
+                docname,
+                '',
+                typ,
+            ))
 
         # convert the dict to the sorted list of tuples expected
         content = sorted(content.items())
@@ -98,7 +104,6 @@ def generate(self, docnames=None):
 
 
 class RecipeDomain(Domain):
-
     name = 'recipe'
     label = 'Recipe Sample'
     roles = {
@@ -122,18 +127,18 @@ def get_full_qualified_name(self, node):
     def get_objects(self):
         yield from self.data['recipes']
 
-    def resolve_xref(self, env, fromdocname, builder, typ, target, node,
-                     contnode):
-        match = [(docname, anchor)
-                 for name, sig, typ, docname, anchor, prio
-                 in self.get_objects() if sig == target]
+    def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode):
+        match = [
+            (docname, anchor)
+            for name, sig, typ, docname, anchor, prio in self.get_objects()
+            if sig == target
+        ]
 
         if len(match) > 0:
             todocname = match[0][0]
             targ = match[0][1]
 
-            return make_refnode(builder, fromdocname, todocname, targ,
-                                contnode, targ)
+            return make_refnode(builder, fromdocname, todocname, targ, contnode, targ)
         else:
             print('Awww, found nothing')
             return None
@@ -145,8 +150,7 @@ def add_recipe(self, signature, ingredients):
 
         self.data['recipe_ingredients'][name] = ingredients
         # name, dispname, type, docname, anchor, priority
-        self.data['recipes'].append(
-            (name, signature, 'Recipe', self.env.docname, anchor, 0))
+        self.data['recipes'].append((name, signature, 'Recipe', self.env.docname, anchor, 0))
 
 
 def setup(app):