Skip to content

Commit aac6e93

Browse files
committed
docs: remove all docstring references to deleted Sphinx docs
1 parent cd207f7 commit aac6e93

File tree

3 files changed

+3
-48
lines changed

3 files changed

+3
-48
lines changed

src/continuedfractions/continuedfraction.py

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,7 @@ def khinchin_mean(self) -> decimal.Decimal | None:
119119
K_n := \\sqrt[n]{a_1a_2 \\cdots a_n} = \\left( a_1a_2 \\cdots a_n \\right)^{\\frac{1}{n}}, \\hskip{3em} n \\geq 1
120120
121121
This property is intended to make it easier to study the limit of
122-
:math:`K_n` as :math:`n \\to \\infty`. See the `documentation <https://continuedfractions.readthedocs.io/en/latest/sources/exploring-continued-fractions.html#khinchin-means-khinchin-s-constant>`_
123-
for more details.
122+
:math:`K_n` as :math:`n \\to \\infty`.
124123
125124
In the special case of integers or fractions representing integers,
126125
whose continued fraction representations consist of only a single
@@ -679,9 +678,6 @@ def remainders(self) -> typing.Generator[tuple[int, ContinuedFraction], None, No
679678
:math:`n + 1` remainders :math:`R_0, R_1, \\ldots, R_n`, and the method
680679
generates these in reverse order :math:`R_0, R_1, \\ldots, R_n`.
681680
682-
See the `documentation <https://continuedfractions.readthedocs.io/sources/continued-fractions.html#remainders>`_
683-
for more details on remainders.
684-
685681
The remainders are generated as tuples of :py:class:`int`
686682
and :py:class:`~continuedfraction.continuedfraction.ContinuedFraction`
687683
instances, where the integers represent the indexes of the remainders.
@@ -720,9 +716,6 @@ def left_mediant(self, other: Fraction, /, *, k: int = 1) -> ContinuedFraction:
720716
721717
\\frac{ka + c}{kb + d}, \\hskip{3em} k \\geq 1
722718
723-
For more information consult the
724-
`documentation <https://continuedfractions.readthedocs.io/sources/sequences.html#sequences-mediants>`_.
725-
726719
Parameters
727720
----------
728721
other : fractions.Fraction, ContinuedFraction
@@ -770,9 +763,6 @@ def right_mediant(self, other: Fraction, /, *, k: int = 1) -> ContinuedFraction:
770763
771764
\\frac{a + kc}{b + kd}, \\hskip{3em} k \\geq 1
772765
773-
For more information consult the
774-
`documentation <https://continuedfractions.readthedocs.io/sources/sequences.html#sequences-mediants>`_.
775-
776766
Parameters
777767
----------
778768
other : fractions.Fraction, ContinuedFraction
@@ -827,9 +817,6 @@ def mediant(self, other: Fraction, /) -> ContinuedFraction:
827817
or :py:meth:`~continuedfractions.continuedfraction.ContinuedFraction.right_mediant`
828818
methods where the order :math:`k` is set to :math:`1`.
829819
830-
For more information consult the
831-
`documentation <https://continuedfractions.readthedocs.io/sources/sequences.html#sequences-mediants>`_.
832-
833820
Parameters
834821
----------
835822
other : fractions.Fraction, ContinuedFraction
@@ -943,8 +930,7 @@ def __pos__(self) -> ContinuedFraction:
943930

944931
def __neg__(self) -> ContinuedFraction:
945932
"""
946-
The negation algorithm for a finite simple continued fraction, as
947-
described `documentation <https://continuedfractions.readthedocs.io/en/latest/sources/continued-fractions.html#negative-continued-fractions>`_.
933+
The negation algorithm for a finite simple continued fraction.
948934
949935
The basic algorithm can be described as follows: if
950936
:math:`[a_0; a_1,\\ldots, a_n]` is the simple continued fraction of a

src/continuedfractions/lib.py

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,6 @@ def continued_fraction_rational(frac: Fraction, /) -> typing.Generator[int, None
5252
5353
Negative rational numbers can also be represented in this way, provided we
5454
use the `Euclidean division lemma <https://en.wikipedia.org/wiki/Euclid%27s_lemma>`_.
55-
This is described in more detail in the `documentation <https://continuedfractions.readthedocs.io/en/latest/sources/creating-continued-fractions.html#negative-continued-fractions>`_.
56-
57-
For a definition of "continued fraction", "coefficient", "order",
58-
"finite continued fraction", "simple continued fraction", please consult
59-
the
60-
`package documentation <https://continuedfractions.readthedocs.io/en/stable>`_,
61-
or any online resource such as
62-
`Wikipedia <https://en.wikipedia.org/wiki/Continued_fraction>`_, or
63-
suitable books on number theory.
6455
6556
Parameters
6657
----------
@@ -321,9 +312,6 @@ def convergents(*coeffs: int) -> typing.Generator[Fraction, None, None]:
321312
:math:`C_0, C_1, \\ldots, C_n`, and the function generates these in that
322313
order.
323314
324-
See the `documentation <https://continuedfractions.readthedocs.io/en/latest/sources/exploring-continued-fractions.html#convergents-and-rational-approximations>`_
325-
for more details on convergents.
326-
327315
Parameters
328316
----------
329317
*elements : `int`
@@ -605,9 +593,6 @@ def remainders(*coeffs: int) -> typing.Generator[Fraction, None, None]:
605593
:math:`R_0, R_1, \\ldots, R_n`, and the function generates these in
606594
reverse order :math:`R_0, R_1, \\ldots, R_n`.
607595
608-
See the `documentation <https://continuedfractions.readthedocs.io/en/latest/sources/exploring-continued-fractions.html#remainders>`_
609-
for more details on remainders.
610-
611596
Parameters
612597
----------
613598
*elements : `int`
@@ -711,9 +696,6 @@ def mediant(r: Fraction, s: Fraction, /, *, dir: str = 'right', k: int = 1) -> F
711696
\\lim_{k \\to \\infty} \\frac{a + kc}{b + kd} &= \\frac{c}{d}
712697
\\end{align}
713698
714-
For more information consult the
715-
`documentation <https://continuedfractions.readthedocs.io/en/latest/sources/mediants.html>`_.
716-
717699
For the left mediant use ``dir="left"``, while for the right use
718700
``dir="right"``. The default is ``dir="right"``. For ``k = 1`` the left and
719701
right mediants are identical to the simple mediant :math:`\\frac{a + c}{b + d}`.

src/continuedfractions/sequences.py

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ def rationals(
3434
By default it generates sequences of all positive rational numbers as
3535
:py:class:`~continuedfractions.continuedfractions.ContinuedFraction`
3636
objects with the user-specified enumeration on Cantor's 2D
37-
representation of the rationals as described in the
38-
`documentation <https://continuedfractions.readthedocs.io/sources/sequences.html#rationals>`_.
37+
representation of the rationals.
3938
4039
To include negative rationals and :math:`0` set ``positive_only`` to
4140
``False``, as described in the documentation and the docstring examples
@@ -113,9 +112,6 @@ def rationals(
113112
* ``"rectilinear"``
114113
* ``"rectilinear transposed"``
115114
116-
These enumerations are described above in the docstring, and also in
117-
the `Sphinx documentation <https://continuedfractions.readthedocs.io/sources/pythagorean-triples.html#primitive-pythagorean-triples>`_
118-
119115
positive_only : bool, default=True
120116
Whether to generate only the positive rationals, which is true by
121117
default.
@@ -439,8 +435,6 @@ class KSRMTree:
439435
is described clearly in the papers of Saunders and Randall, and of
440436
Mitchell.
441437
442-
See the `documentation <https://continuedfractions.readthedocs.io/en/latest/sources/sequences.html#ksrm-trees>`_
443-
for more details.
444438
"""
445439

446440
# The two slots for the private attributes for the key tree features - the
@@ -478,8 +472,6 @@ def roots(self) -> typing.Literal[((2, 1), (3, 1))]:
478472
* Mitchell, D. W. (2001). An Alternative Characterisation of All Primitive Pythagorean Triples. The Mathematical Gazette, 85(503), 273-275. https://doi.org/10.2307/3622017
479473
* Saunders, R., & Randall, T. (1994). The family tree of the Pythagorean triplets revisited. The Mathematical Gazette, 78(482), 190-193. https://doi.org/10.2307/3618576
480474
481-
or the `documentation <https://continuedfractions.readthedocs.io/en/latest/sources/sequences.html#ksrm-trees>`_.
482-
483475
Examples
484476
--------
485477
>>> KSRMTree().roots
@@ -507,8 +499,6 @@ def branches(self) -> tuple[KSRMTreeBranch]: # noqa: F821
507499
* Mitchell, D. W. (2001). An Alternative Characterisation of All Primitive Pythagorean Triples. The Mathematical Gazette, 85(503), 273-275. https://doi.org/10.2307/3622017
508500
* Saunders, R., & Randall, T. (1994). The family tree of the Pythagorean triplets revisited. The Mathematical Gazette, 78(482), 190-193. https://doi.org/10.2307/3618576
509501
510-
or the `documentation <https://continuedfractions.readthedocs.io/en/latest/sources/sequences.html#ksrm-trees>`_.
511-
512502
Examples
513503
--------
514504
Generating the first two generations of children for the parent
@@ -962,9 +952,6 @@ def farey_sequence(n: int, /) -> typing.Generator[FareyFraction, None, None]:
962952
:py:class:`~continuedfractions.sequences.FareyFraction`
963953
instances, in ascending order of magnitude.
964954
965-
See the `documentation <https://continuedfractions.readthedocs.io/en/latest/sources/sequences.html#sequences-farey-sequences>`_
966-
for more details.
967-
968955
Parameters
969956
----------
970957
n : int:

0 commit comments

Comments
 (0)