Skip to content
This repository was archived by the owner on Jan 30, 2023. It is now read-only.

Commit 1d5d52a

Browse files
committed
trac #15553: Broken links in the doc of graph/ and numerical/
1 parent 3735dfd commit 1d5d52a

File tree

8 files changed

+46
-43
lines changed

8 files changed

+46
-43
lines changed

src/sage/graphs/distances_all_pairs.pyx

+2-2
Original file line numberDiff line numberDiff line change
@@ -483,8 +483,8 @@ def is_distance_regular(G, parameters = False):
483483
484484
.. SEEALSO::
485485
486-
* :meth:`Graph.is_regular`
487-
* :meth:`Graph.is_strongly_regular`
486+
* :meth:`~sage.graphs.generic_graph.GenericGraph.is_regular`
487+
* :meth:`~Graph.is_strongly_regular`
488488
489489
EXAMPLES::
490490

src/sage/graphs/generic_graph.py

+16-15
Original file line numberDiff line numberDiff line change
@@ -1224,10 +1224,11 @@ def distance_matrix(self):
12241224
.. WARNING::
12251225

12261226
The ordering of vertices in the matrix has no reason to correspond
1227-
to the order of vertices in :meth:`~Graph.vertices`. In particular,
1228-
if two integers `i,j` are vertices of a graph `G` with distance
1229-
matrix ``M``, then ``M[i][i]`` is not necessarily the distance
1230-
between vertices `i` and `j`.
1227+
to the order of vertices in
1228+
:meth:`~sage.graphs.generic_graph.GenericGraph.vertices`. In
1229+
particular, if two integers `i,j` are vertices of a graph `G` with
1230+
distance matrix ``M``, then ``M[i][i]`` is not necessarily the
1231+
distance between vertices `i` and `j`.
12311232

12321233
EXAMPLES::
12331234

@@ -1250,8 +1251,8 @@ def distance_matrix(self):
12501251

12511252
.. SEEALSO::
12521253

1253-
* :meth:`~sage.graphs.generic_graph.distance_all_pairs` -- computes
1254-
the distance between any two vertices.
1254+
* :meth:`~sage.graphs.generic_graph.GenericGraph.distance_all_pairs`
1255+
-- computes the distance between any two vertices.
12551256
"""
12561257

12571258
from sage.matrix.constructor import matrix
@@ -10828,9 +10829,10 @@ def is_circulant(self, certificate = False):
1082810829
lists_of_parameters)`` each element of ``lists_of_parameters`` can be
1082910830
used to define the graph as a circulant graph.
1083010831

10831-
See the documentation of :meth:`graphs.CirculantGraph` and
10832-
:meth:`digraphs.CirculantGraph` for more information, and the examples
10833-
below.
10832+
See the documentation of
10833+
:func:`~sage.graphs.graph_generators.GraphGenerators.CirculantGraph` and
10834+
:meth:`~sage.graphs.digraph_generators.DiGraphGenerators.Circulant` for
10835+
more information, and the examples below.
1083410836

1083510837
.. SEEALSO::
1083610838

@@ -11562,7 +11564,7 @@ def distance_all_pairs(self, algorithm = "auto"):
1156211564

1156311565
.. SEEALSO::
1156411566

11565-
* :meth:`~sage.graphs.generic_graph.distance_matrix`
11567+
* :meth:`~sage.graphs.generic_graph.GenericGraph.distance_matrix`
1156611568
"""
1156711569
if algorithm == "auto":
1156811570
if self.order() <= 20:
@@ -14731,7 +14733,7 @@ def plot(self, **options):
1473114733
be set through the :class:`~sage.misc.decorators.options`
1473214734
mechanism. For more information on this different way to set
1473314735
default parameters, see the help of the :class:`options decorator
14734-
<~sage.misc.decorators.options>`.
14736+
<sage.misc.decorators.options>`.
1473514737

1473614738
- See also the :mod:`sage.graphs.graph_latex` module for ways to use
1473714739
LaTeX to produce an image of a graph.
@@ -14932,8 +14934,8 @@ def show(self, **kwds):
1493214934
INPUT:
1493314935

1493414936
This method accepts any option understood by
14935-
:meth:`~sage.graphs.generic_graph.plot` (graph-specific) or by
14936-
:meth:`sage.plot.graphics.Graphics.show`.
14937+
:meth:`~sage.graphs.generic_graph.GenericGraph.plot` (graph-specific) or
14938+
by :meth:`sage.plot.graphics.Graphics.show`.
1493714939

1493814940
.. NOTE::
1493914941

@@ -15094,7 +15096,6 @@ def plot3d(self, bgcolor=(1,1,1),
1509415096

1509515097
- :meth:`plot`
1509615098
- :meth:`graphviz_string`
15097-
- :meth:`_color_by_label`
1509815099
"""
1509915100
import graph_plot
1510015101
layout_options = dict( (key,kwds[key]) for key in kwds.keys() if key in graph_plot.layout_options )
@@ -15935,7 +15936,7 @@ def eigenspaces(self, laplacian=False):
1593515936

1593615937
For some graphs, some of the the eigenspaces are described
1593715938
exactly by vector spaces over a
15938-
:class:`~sage.rings.number_field.number_field.NumberField`.
15939+
:func:`~sage.rings.number_field.number_field.NumberField`.
1593915940
For numerical eigenvectors use :meth:`eigenvectors`.
1594015941

1594115942
EXAMPLES::

src/sage/graphs/graph.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -2821,7 +2821,7 @@ def is_semi_symmetric(self):
28212821
28222822
- :meth:`~Graph.is_edge_transitive`
28232823
- :meth:`~Graph.is_arc_transitive`
2824-
- :meth:`~Graph.is_half-transitive`
2824+
- :meth:`~Graph.is_half_transitive`
28252825
28262826
EXAMPLES:
28272827
@@ -4918,7 +4918,7 @@ def clique_maximum(self, algorithm="Cliquer"):
49184918
- If ``algorithm = "MILP"``, the problem is solved through a Mixed
49194919
Integer Linear Program.
49204920
4921-
(see :class:`MixedIntegerLinearProgram <sage.numerical.mip>`)
4921+
(see :class:`~sage.numerical.mip.MixedIntegerLinearProgram`)
49224922
49234923
.. NOTE::
49244924
@@ -4984,7 +4984,7 @@ def clique_number(self, algorithm="Cliquer", cliques=None):
49844984
- If ``algorithm = "MILP"``, the problem is solved through a Mixed
49854985
Integer Linear Program.
49864986
4987-
(see :class:`MixedIntegerLinearProgram <sage.numerical.mip>`)
4987+
(see :class:`~sage.numerical.mip.MixedIntegerLinearProgram`)
49884988
49894989
- ``cliques`` - an optional list of cliques that can be input if
49904990
already computed. Ignored unless ``algorithm=="networkx"``.
@@ -5164,7 +5164,7 @@ def independent_set(self, algorithm = "Cliquer", value_only = False, reduction_r
51645164
* If ``algorithm = "MILP"``, the problem is solved through a Mixed
51655165
Integer Linear Program.
51665166
5167-
(see :class:`MixedIntegerLinearProgram <sage.numerical.mip>`)
5167+
(see :class:`~sage.numerical.mip.MixedIntegerLinearProgram`)
51685168
51695169
- ``value_only`` -- boolean (default: ``False``). If set to ``True``,
51705170
only the size of a maximum independent set is returned. Otherwise,
@@ -5179,9 +5179,9 @@ def independent_set(self, algorithm = "Cliquer", value_only = False, reduction_r
51795179
solver to be used. If set to ``None``, the default one is used. For
51805180
more information on LP solvers and which default solver is used, see
51815181
the method
5182-
:meth:`solve <sage.numerical.mip.MixedIntegerLinearProgram.solve>`
5182+
:meth:`~sage.numerical.mip.MixedIntegerLinearProgram.solve`
51835183
of the class
5184-
:class:`MixedIntegerLinearProgram <sage.numerical.mip.MixedIntegerLinearProgram>`.
5184+
:class:`~sage.numerical.mip.MixedIntegerLinearProgram`.
51855185
51865186
- ``verbosity`` -- non-negative integer (default: ``0``). Set the level
51875187
of verbosity you want from the linear program solver. Since the

src/sage/graphs/graph_plot.py

+9-8
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
2727
**Plot options**
2828
29-
Here is the list of options accepted by :meth:`GenericGraph.plot
30-
<sage.graphs.generic_graph.GenericGraph.plot>` and the constructor of
29+
Here is the list of options accepted by
30+
:meth:`~sage.graphs.generic_graph.GenericGraph.plot` and the constructor of
3131
:class:`GraphPlot`.
3232
3333
.. csv-table::
@@ -94,16 +94,17 @@
9494
**Default options**
9595
9696
This module defines two dictionaries containing default options for the
97-
:meth:`GenericGraph.plot` and :meth:`GenericGraph.show` methods. These two
98-
dictionaries are ``sage.graphs.graph_plot.DEFAULT_PLOT_OPTIONS`` and
97+
:meth:`~sage.graphs.generic_graph.GenericGraph.plot` and
98+
:meth:`~sage.graphs.generic_graph.GenericGraph.show` methods. These two dictionaries are
99+
``sage.graphs.graph_plot.DEFAULT_PLOT_OPTIONS`` and
99100
``sage.graphs.graph_plot.DEFAULT_SHOW_OPTIONS``, respectively.
100101
101102
102103
Obviously, these values are overruled when arguments are given explicitly.
103104
104105
Here is how to define the default size of a graph drawing to be ``[6,6]``. The
105-
first two calls to :meth:`~sage.graphs.generic_graph.show` use this option,
106-
while the third does not (a value for ``figsize`` is explicitly given)::
106+
first two calls to :meth:`~sage.graphs.generic_graph.GenericGraph.show` use this
107+
option, while the third does not (a value for ``figsize`` is explicitly given)::
107108
108109
sage: sage.graphs.graph_plot.DEFAULT_SHOW_OPTIONS['figsize'] = [6,6]
109110
sage: graphs.PetersenGraph().show() # long time
@@ -696,7 +697,7 @@ def show(self, **kwds):
696697
information on default values of this method.
697698
698699
- Any options not used by plot will be passed on to the
699-
:meth:`~sage.plot.plot.Graphics.show` method.
700+
:meth:`~sage.plot.graphics.Graphics.show` method.
700701
701702
EXAMPLE::
702703
@@ -719,7 +720,7 @@ def plot(self, **kwds):
719720
720721
The options accepted by this method are to be found in the documentation
721722
of the :mod:`sage.graphs.graph_plot` module, and the
722-
:meth:`~sage.plot.plot.Graphics.show` method.
723+
:meth:`~sage.plot.graphics.Graphics.show` method.
723724
724725
.. NOTE::
725726

src/sage/graphs/isgci.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@
111111
* - BinaryTrees
112112
113113
- :meth:`~sage.graphs.graph_generators.GraphGenerators.BalancedTree`,
114-
:meth:`~sage.graphs.generic_graph.GenericGraph.is_tree`
114+
:meth:`~Graph.is_tree`
115115
116116
* - Bipartite
117117
@@ -172,7 +172,7 @@
172172
* - Tree
173173
174174
- :meth:`~sage.graphs.graph_generators.GraphGenerators.trees`,
175-
:meth:`~sage.graphs.generic_graph.GenericGraph.is_tree`
175+
:meth:`~Graph.is_tree`
176176
177177
* - UnitDisk
178178
- :meth:`~sage.graphs.graph_generators.GraphGenerators.IntervalGraph`,

src/sage/graphs/line_graph.py

+5-4
Original file line numberDiff line numberDiff line change
@@ -161,10 +161,11 @@ def is_line_graph(g, certificate = False):
161161
162162
This method sequentially tests each of the forbidden subgraphs in order
163163
to know whether the graph is a line graph, which is a very slow
164-
method. It could eventually be replaced by :meth:`root_graph` when this
165-
method will not require an exponential time to run on general graphs
166-
anymore (see its documentation for more information on this problem)...
167-
and if it can be improved to return negative certificates !
164+
method. It could eventually be replaced by
165+
:func:`~sage.graphs.line_graph.root_graph` when this method will not
166+
require an exponential time to run on general graphs anymore (see its
167+
documentation for more information on this problem)... and if it can be
168+
improved to return negative certificates !
168169
169170
.. NOTE::
170171

src/sage/numerical/backends/generic_backend.pyx

+1-1
Original file line numberDiff line numberDiff line change
@@ -848,7 +848,7 @@ cdef class GenericBackend:
848848
.. NOTE::
849849
850850
The list of available parameters is available at
851-
:meth:`sage.numerical.mip.MixedIntegerlinearProgram.solver_parameter`
851+
:meth:`~sage.numerical.mip.MixedIntegerLinearProgram.solver_parameter`.
852852
853853
EXAMPLE::
854854

src/sage/numerical/mip.pyx

+5-5
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ cdef class MixedIntegerLinearProgram(SageObject):
358358
"""
359359
Return the parent for all linear constraints
360360
361-
See :mod:`~sage.numerical.linear_constraints` for more
361+
See :mod:`~sage.numerical.linear_functions` for more
362362
details.
363363
364364
EXAMPLES::
@@ -739,11 +739,11 @@ cdef class MixedIntegerLinearProgram(SageObject):
739739
INPUT:
740740
741741
All arguments given to this method are forwarded to the constructor of
742-
the :class:`Polyhedron` class.
742+
the :func:`Polyhedron` class.
743743
744744
OUTPUT:
745745
746-
A :class:`Polyhedron` object whose `i`-th variable represents the `i`-th
746+
A :func:`Polyhedron` object whose `i`-th variable represents the `i`-th
747747
variable of ``self``.
748748
749749
.. warning::
@@ -1994,13 +1994,13 @@ cdef class MixedIntegerLinearProgram(SageObject):
19941994
cpdef sum(self, L):
19951995
r"""
19961996
Efficiently computes the sum of a sequence of
1997-
:class:`~sage.numerical.linear_function.LinearFunction` elements
1997+
:class:`~sage.numerical.linear_functions.LinearFunction` elements
19981998
19991999
INPUT:
20002000
20012001
- ``mip`` -- the :class:`MixedIntegerLinearProgram` parent.
20022002
2003-
- ``L`` -- list of :class:`~sage.numerical.linear_function.LinearFunction` instances.
2003+
- ``L`` -- list of :class:`~sage.numerical.linear_functions.LinearFunction` instances.
20042004
20052005
.. NOTE::
20062006

0 commit comments

Comments
 (0)