Skip to content

Commit dea267e

Browse files
authored
Improve documentation (#1256)
* Remove documentation link to TimezoneTransition (removed in #958) * Document more APIs * Upgrade Sphinx * Belatedly bump version in docs
1 parent 68999b1 commit dea267e

File tree

6 files changed

+54
-10
lines changed

6 files changed

+54
-10
lines changed

docs/api/dates.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,6 @@ Timezone Functionality
4040

4141
A timezone object for the computer's local timezone.
4242

43-
.. autoclass:: TimezoneTransition
44-
4543
Data Access
4644
-----------
4745

@@ -69,3 +67,9 @@ Basic Parsing
6967
.. autofunction:: parse_time
7068

7169
.. autofunction:: parse_pattern
70+
71+
Exceptions
72+
----------
73+
74+
.. autoexception:: ParseError
75+
:members:

docs/api/numbers.rst

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,47 @@ Exceptions
3636
.. autoexception:: NumberFormatError
3737
:members:
3838

39+
.. autoexception:: UnknownCurrencyError
40+
:members:
41+
42+
.. autoexception:: UnknownCurrencyFormatError
43+
:members:
44+
45+
.. autoexception:: UnsupportedNumberingSystemError
46+
:members:
47+
3948
Data Access
4049
-----------
4150

51+
.. autofunction:: get_decimal_symbol
52+
53+
.. autofunction:: get_exponential_symbol
54+
55+
.. autofunction:: get_group_symbol
56+
57+
.. autofunction:: get_infinity_symbol
58+
59+
.. autofunction:: get_minus_sign_symbol
60+
61+
.. autofunction:: get_plus_sign_symbol
62+
63+
Currency Utilities
64+
------------------
65+
4266
.. autofunction:: get_currency_name
4367

68+
.. autofunction:: get_currency_precision
69+
4470
.. autofunction:: get_currency_symbol
4571

4672
.. autofunction:: get_currency_unit_pattern
4773

48-
.. autofunction:: get_decimal_symbol
74+
.. autofunction:: get_territory_currencies
4975

50-
.. autofunction:: get_plus_sign_symbol
76+
.. autofunction:: is_currency
5177

52-
.. autofunction:: get_minus_sign_symbol
78+
.. autofunction:: list_currencies
5379

54-
.. autofunction:: get_territory_currencies
80+
.. autofunction:: normalize_currency
81+
82+
.. autofunction:: validate_currency

docs/api/plural.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,9 @@ Conversion Functionality
2121
.. autofunction:: to_python
2222

2323
.. autofunction:: to_gettext
24+
25+
Exceptions
26+
----------
27+
28+
.. autoexception:: RuleError
29+
:members:

docs/api/units.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,9 @@ locales.
1111
.. autofunction:: format_compound_unit
1212

1313
.. autofunction:: get_unit_name
14+
15+
Exceptions
16+
----------
17+
18+
.. autoexception:: UnknownUnitError
19+
:members:

docs/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,16 @@
4444

4545
# General information about the project.
4646
project = 'Babel'
47-
copyright = '2025, The Babel Team'
47+
copyright = '2026, The Babel Team'
4848

4949
# The version info for the project you're documenting, acts as replacement for
5050
# |version| and |release|, also used in various other places throughout the
5151
# built documents.
5252
#
5353
# The short X.Y version.
54-
version = '2.17'
54+
version = '2.18'
5555
# The full version, including alpha/beta/rc tags.
56-
release = '2.17.0'
56+
release = '2.18.0'
5757

5858
# The language for content autogenerated by Sphinx. Refer to documentation
5959
# for a list of supported languages.

docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Sphinx~=5.3.0
1+
Sphinx~=9.1.0

0 commit comments

Comments
 (0)