Sphinx 7.2.5__py3-none-any.whl → 7.3.0__py3-none-any.whl

sphinx/writers/text.py

@@ -5,7 +5,7 @@ import math
 import os
 import re
 import textwrap
-from collections.abc import Generator, Iterable, Sequence
+from collections.abc import Iterable, Iterator, Sequence
 from itertools import chain, groupby
 from typing import TYPE_CHECKING, Any, cast
 
@@ -26,6 +26,7 @@ class Cell:
     """Represents a cell in a table.
     It can span multiple columns or multiple lines.
     """
+
     def __init__(self, text: str = "", rowspan: int = 1, colspan: int = 1) -> None:
         self.text = text
         self.wrapped: list[str] = []
@@ -93,6 +94,7 @@ class Table:
        +--------+--------+
 
     """
+
     def __init__(self, colwidth: list[int] | None = None) -> None:
         self.lines: list[list[Cell]] = []
         self.separator = 0
@@ -148,7 +150,7 @@ class Table:
                 line.append(Cell())
 
     def __repr__(self) -> str:
-        return "\n".join(repr(line) for line in self.lines)
+        return "\n".join(map(repr, self.lines))
 
     def cell_width(self, cell: Cell, source: list[int]) -> int:
         """Give the cell width, according to the given source (either
@@ -164,7 +166,7 @@ class Table:
         return width + (cell.colspan - 1) * 3
 
     @property
-    def cells(self) -> Generator[Cell, None, None]:
+    def cells(self) -> Iterator[Cell]:
         seen: set[Cell] = set()
         for line in self.lines:
             for cell in line:
@@ -262,9 +264,8 @@ class TextWrapper(textwrap.TextWrapper):
         r'(?<=[\w\!\"\'\&\.\,\?])-{2,}(?=\w))')   # em-dash
 
     def _wrap_chunks(self, chunks: list[str]) -> list[str]:
-        """_wrap_chunks(chunks : [string]) -> [string]
+        """The original _wrap_chunks uses len() to calculate width.
 
-        The original _wrap_chunks uses len() to calculate width.
         This method respects wide/fullwidth characters for width adjustment.
         """
         lines: list[str] = []
@@ -309,10 +310,7 @@ class TextWrapper(textwrap.TextWrapper):
         return lines
 
     def _break_word(self, word: str, space_left: int) -> tuple[str, str]:
-        """_break_word(word : string, space_left : int) -> (string, string)
-
-        Break line by unicode width instead of len(word).
-        """
+        """Break line by unicode width instead of len(word)."""
         total = 0
         for i, c in enumerate(word):
             total += column_width(c)
@@ -321,9 +319,8 @@ class TextWrapper(textwrap.TextWrapper):
         return word, ''
 
     def _split(self, text: str) -> list[str]:
-        """_split(text : string) -> [string]
+        """Override original method that only split by 'wordsep_re'.
 
-        Override original method that only split by 'wordsep_re'.
         This '_split' splits wide-characters into chunks by one character.
         """
         def split(t: str) -> list[str]:
@@ -339,12 +336,7 @@ class TextWrapper(textwrap.TextWrapper):
 
     def _handle_long_word(self, reversed_chunks: list[str], cur_line: list[str],
                           cur_len: int, width: int) -> None:
-        """_handle_long_word(chunks : [string],
-                             cur_line : [string],
-                             cur_len : int, width : int)
-
-        Override original method for using self._break_word() instead of slice.
-        """
+        """Override original method for using self._break_word() instead of slice."""
         space_left = max(width - cur_len, 1)
         if self.break_long_words:
             l, r = self._break_word(reversed_chunks[-1], space_left)
@@ -693,8 +685,8 @@ class TextTranslator(SphinxTranslator):
         self.visit_desc_parameter(node)
 
     def visit_desc_optional(self, node: Element) -> None:
-        self.params_left_at_level = sum([isinstance(c, addnodes.desc_parameter)
-                                         for c in node.children])
+        self.params_left_at_level = sum(isinstance(c, addnodes.desc_parameter)
+                                        for c in node.children)
         self.optional_param_level += 1
         self.max_optional_param_level = self.optional_param_level
         if self.multi_line_parameter_list:
@@ -757,10 +749,8 @@ class TextTranslator(SphinxTranslator):
 
     def visit_productionlist(self, node: Element) -> None:
         self.new_state()
-        names = []
         productionlist = cast(Iterable[addnodes.production], node)
-        for production in productionlist:
-            names.append(production['tokenname'])
+        names = (production['tokenname'] for production in productionlist)
         maxlen = max(len(name) for name in names)
         lastname = None
         for production in productionlist:
@@ -1289,7 +1279,7 @@ class TextTranslator(SphinxTranslator):
         if 'text' in node.get('format', '').split():
             self.new_state(0)
             self.add_text(node.astext())
-            self.end_state(wrap = False)
+            self.end_state(wrap=False)
         raise nodes.SkipNode
 
     def visit_math(self, node: Element) -> None:

sphinx/writers/xml.py

@@ -48,5 +48,5 @@ class PseudoXMLWriter(BaseXMLWriter):
         self.output = self.document.pformat()
 
     def supports(self, format: str) -> bool:
-        """This writer supports all format-specific elements."""
+        """All format-specific elements are supported."""
         return True

sphinx-7.2.5.dist-info/LICENSE → sphinx-7.3.0.dist-info/LICENSE.rst

@@ -4,7 +4,7 @@ License for Sphinx
 Unless otherwise indicated, all code in the Sphinx project is licenced under the
 two clause BSD licence below.
 
-Copyright (c) 2007-2023 by the Sphinx team (see AUTHORS file).
+Copyright (c) 2007-2024 by the Sphinx team (see AUTHORS file).
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

{sphinx-7.2.5.dist-info → sphinx-7.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Sphinx
-Version: 7.2.5
+Version: 7.3.0
 Summary: Python documentation generator
 Author-email: Georg Brandl <georg@python.org>
 Requires-Python: >=3.9
@@ -26,6 +26,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Domain
 Classifier: Framework :: Sphinx :: Extension
 Classifier: Framework :: Sphinx :: Theme
 Classifier: Topic :: Documentation
@@ -49,10 +50,10 @@ Requires-Dist: sphinxcontrib-serializinghtml>=1.1.9
 Requires-Dist: sphinxcontrib-qthelp
 Requires-Dist: Jinja2>=3.0
 Requires-Dist: Pygments>=2.14
-Requires-Dist: docutils>=0.18.1,<0.21
+Requires-Dist: docutils>=0.18.1,<0.22
 Requires-Dist: snowballstemmer>=2.0
 Requires-Dist: babel>=2.9
-Requires-Dist: alabaster>=0.7,<0.8
+Requires-Dist: alabaster~=0.7.14
 Requires-Dist: imagesize>=1.3
 Requires-Dist: requests>=2.25.0
 Requires-Dist: packaging>=21.0
@@ -60,18 +61,18 @@ Requires-Dist: importlib-metadata>=4.8; python_version < '3.10'
 Requires-Dist: colorama>=0.4.5; sys_platform == 'win32'
 Requires-Dist: sphinxcontrib-websupport ; extra == "docs"
 Requires-Dist: flake8>=3.5.0 ; extra == "lint"
-Requires-Dist: flake8-simplify ; extra == "lint"
-Requires-Dist: isort ; extra == "lint"
-Requires-Dist: ruff ; extra == "lint"
-Requires-Dist: mypy>=0.990 ; extra == "lint"
+Requires-Dist: ruff==0.3.7 ; extra == "lint"
+Requires-Dist: mypy==1.9.0 ; extra == "lint"
 Requires-Dist: sphinx-lint ; extra == "lint"
-Requires-Dist: docutils-stubs ; extra == "lint"
+Requires-Dist: types-docutils ; extra == "lint"
 Requires-Dist: types-requests ; extra == "lint"
-Requires-Dist: pytest>=4.6 ; extra == "test"
-Requires-Dist: html5lib ; extra == "test"
+Requires-Dist: importlib_metadata ; extra == "lint"
+Requires-Dist: tomli ; extra == "lint"
+Requires-Dist: pytest>=6.0 ; extra == "lint"
+Requires-Dist: pytest>=6.0 ; extra == "test"
+Requires-Dist: defusedxml>=0.7.1 ; extra == "test"
 Requires-Dist: cython>=3.0 ; extra == "test"
 Requires-Dist: setuptools>=67.0 ; extra == "test"
-Requires-Dist: filelock ; extra == "test"
 Project-URL: Changelog, https://www.sphinx-doc.org/en/master/changes.html
 Project-URL: Code, https://github.com/sphinx-doc/sphinx
 Project-URL: Download, https://pypi.org/project/Sphinx/
@@ -123,7 +124,7 @@ Features
 * **Language Support**: Python, C, C++, JavaScript, mathematics, and many other
   languages through extensions.
 
-For more information, refer to the `the documentation`_.
+For more information, refer to `the documentation`_.
 
 Installation
 ============