]> git.ipfire.org Git - thirdparty/babel.git/commitdiff
Improve documentation (#1256) master
authorAarni Koskela <akx@iki.fi>
Wed, 18 Feb 2026 11:45:04 +0000 (13:45 +0200)
committerGitHub <noreply@github.com>
Wed, 18 Feb 2026 11:45:04 +0000 (13:45 +0200)
* Remove documentation link to TimezoneTransition (removed in #958)

* Document more APIs

* Upgrade Sphinx

* Belatedly bump version in docs

docs/api/dates.rst
docs/api/numbers.rst
docs/api/plural.rst
docs/api/units.rst
docs/conf.py
docs/requirements.txt

index cbdac593b1c9730ace2fdc0687d08c0af085a396..9f0c80b574e6a598dfb1facaec0274566ed940e0 100644 (file)
@@ -40,8 +40,6 @@ Timezone Functionality
 
     A timezone object for the computer's local timezone.
 
-.. autoclass:: TimezoneTransition
-
 Data Access
 -----------
 
@@ -69,3 +67,9 @@ Basic Parsing
 .. autofunction:: parse_time
 
 .. autofunction:: parse_pattern
+
+Exceptions
+----------
+
+.. autoexception:: ParseError
+    :members:
index d3ab8b1166bc435c91a9bf58cd5f69fdf9b311df..c43bd56d2683cd4651c667e3d5bdd27e1d2bada8 100644 (file)
@@ -36,19 +36,47 @@ Exceptions
 .. autoexception:: NumberFormatError
     :members:
 
+.. autoexception:: UnknownCurrencyError
+    :members:
+
+.. autoexception:: UnknownCurrencyFormatError
+    :members:
+
+.. autoexception:: UnsupportedNumberingSystemError
+    :members:
+
 Data Access
 -----------
 
+.. autofunction:: get_decimal_symbol
+
+.. autofunction:: get_exponential_symbol
+
+.. autofunction:: get_group_symbol
+
+.. autofunction:: get_infinity_symbol
+
+.. autofunction:: get_minus_sign_symbol
+
+.. autofunction:: get_plus_sign_symbol
+
+Currency Utilities
+------------------
+
 .. autofunction:: get_currency_name
 
+.. autofunction:: get_currency_precision
+
 .. autofunction:: get_currency_symbol
 
 .. autofunction:: get_currency_unit_pattern
 
-.. autofunction:: get_decimal_symbol
+.. autofunction:: get_territory_currencies
 
-.. autofunction:: get_plus_sign_symbol
+.. autofunction:: is_currency
 
-.. autofunction:: get_minus_sign_symbol
+.. autofunction:: list_currencies
 
-.. autofunction:: get_territory_currencies
+.. autofunction:: normalize_currency
+
+.. autofunction:: validate_currency
index d6934b576cd18d85e64d372197478d4b735a640e..c40f29f04cc47705da83f87d904f3e4db78f7a51 100644 (file)
@@ -21,3 +21,9 @@ Conversion Functionality
 .. autofunction:: to_python
 
 .. autofunction:: to_gettext
+
+Exceptions
+----------
+
+.. autoexception:: RuleError
+    :members:
index 2b99be547325285c7fa84788258cfa1094853ff5..db94b7055178ed56d62da2b240443091bf5b6a7b 100644 (file)
@@ -11,3 +11,9 @@ locales.
 .. autofunction:: format_compound_unit
 
 .. autofunction:: get_unit_name
+
+Exceptions
+----------
+
+.. autoexception:: UnknownUnitError
+    :members:
index b22b78c4f8565606d25aecccf81d8ba05199d5cf..eb817579678d4cd72a8cb00b54512a93d43a32ff 100644 (file)
@@ -44,16 +44,16 @@ master_doc = 'index'
 
 # General information about the project.
 project = 'Babel'
-copyright = '2025, The Babel Team'
+copyright = '2026, The Babel Team'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '2.17'
+version = '2.18'
 # The full version, including alpha/beta/rc tags.
-release = '2.17.0'
+release = '2.18.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
index c133306c70ffb973f6e31d61a56ba347c32a85e1..4864c69dde21341418ac9e245f47864114e0c27a 100644 (file)
@@ -1 +1 @@
-Sphinx~=5.3.0
+Sphinx~=9.1.0