Skip to content

Commit bab6271

Browse files
Doc: Stop duplicating common links
1 parent 9bfe50e commit bab6271

6 files changed

Lines changed: 18 additions & 25 deletions

File tree

docs/source/data-structures/misc/libsemigroups-error.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,7 @@ Full API
4545
If you believe your code is incorrectly throwing a
4646
:any:`LibsemigroupsError`, or isn't throwing a :any:`LibsemigroupsError`
4747
but you think it should, please let us known by opening an issue on the
48-
`issue tracker
49-
<https://github.com/libsemigroups/libsemigroups_pybind11/issues>`_.
48+
`issue tracker`_.
5049

5150
.. autofunction:: error_message_with_prefix
5251

docs/source/data-structures/visualisation/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ This page contains links to the classes and functions in
1313
objects implemented in ``libsemigroups_pybind11``.
1414

1515
The class :any:`Dot` facilitates the creation and rendering of graph
16-
descriptions in the `DOT <https://www.graphviz.org/doc/info/lang.html>`_
17-
language of `Graphviz <https://www.graphviz.org>`_ graph drawing software.
16+
descriptions in the DOT_ language of Graphviz_ graph drawing software.
1817

1918
.. toctree::
2019
:maxdepth: 1

docs/source/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,7 @@ defined upon. These may appear in error messages. For example:
106106
The :doc:`authors <authors>` of ``libsemigroups_pybind11`` have gone to a lot of
107107
effort to try and make error messages clear, specific and intelligible; however,
108108
if there you encounter any errors with unclear messages, please raise this on
109-
the
110-
`issue tracker <https://github.com/libsemigroups/libsemigroups_pybind11/issues>`_.
109+
the `issue tracker`_.
111110

112111
Further Info
113112
------------

docs/source/install.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,5 +104,5 @@ Issues
104104
------
105105

106106
If you find any problems with ``libsemigroups_pybind11``, or have any
107-
suggestions for features that you’d like to see, please use the `issue tracker
108-
<https://github.com/libsemigroups/libsemigroups_pybind11/issues>`__.
107+
suggestions for features that you’d like to see, please use the
108+
`issue tracker`_.

docs/source/links.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
.. _libsemigroups: https://libsemigroups.github.io/libsemigroups/
1+
.. _libsemigroups: https://libsemigroups.github.io/libsemigroups/
2+
.. _issue tracker: https://github.com/libsemigroups/libsemigroups_pybind11/issues
3+
.. _DOT: https://www.graphviz.org/doc/info/lang.html
4+
.. _Graphviz: https://www.graphviz.org

src/dot.cpp

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,16 @@ namespace libsemigroups {
3737
////////////////////////////////////////////////////////////////////////////
3838
py::class_<Dot> dot(m,
3939
"Dot",
40-
R"pbdoc(A representation of a graph in the `DOT
41-
<https://www.graphviz.org/doc/info/lang.html>`_
42-
language of `Graphviz <https://www.graphviz.org>`_.
40+
R"pbdoc(A representation of a graph in the DOT_ language
41+
of Graphviz_.
4342
4443
This class facilitates the creation and rendering of graph descriptions in the
45-
`DOT <https://www.graphviz.org/doc/info/lang.html>`_
46-
language of the `Graphviz <https://www.graphviz.org>`_ graph drawing software.
47-
This class is fairly rudimentary, and is not intended to implement every
48-
feature of the `DOT <https://www.graphviz.org/doc/info/lang.html>`_ language.
49-
You can create a :any:`Dot` object, assemble the graph by adding nodes and
50-
edges, attributes, labels, colours, subgraphs, and clusters, and retrieve its
51-
`DOT <https://www.graphviz.org/doc/info/lang.html>`_
52-
source code string (:any:`Dot.to_string`). Write the source code to a file and
53-
render it with the `Graphviz <https://www.graphviz.org>`_
54-
installation on your system.
44+
DOT_ language of the Graphviz_ graph drawing software. This class is fairly
45+
rudimentary, and is not intended to implement every feature of the DOT_
46+
language. You can create a :any:`Dot` object, assemble the graph by adding nodes
47+
and edges, attributes, labels, colours, subgraphs, and clusters, and retrieve
48+
its DOT_ source code string (:any:`Dot.to_string`). Write the source code to a
49+
file and render it with the Graphviz_ installation on your system.
5550
)pbdoc");
5651

5752
////////////////////////////////////////////////////////////////////////////
@@ -467,9 +462,7 @@ Returns the edge object with head named *head* and tail named *tail*.
467462
R"pbdoc(
468463
Convert a :any:`Dot` object to a string. This function returns the string
469464
representation of the :any:`Dot` object. This string contains a
470-
representation of the graph in the `DOT
471-
<https://www.graphviz.org/doc/info/lang.html>`_ language for `Graphviz
472-
<https://www.graphviz.org>`_.
465+
representation of the graph in the DOT_ language for Graphviz_.
473466
474467
:returns:
475468
The string representation of *self*.

0 commit comments

Comments
 (0)