Skip to content

Commit 9e7f8aa

Browse files
Doc: make libsemigroups link global
1 parent 11b6744 commit 9e7f8aa

11 files changed

Lines changed: 7 additions & 13 deletions

File tree

docs/source/authors.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,3 @@ Contributors
3131
packaging.
3232

3333
.. _nicolas thiery: http://nicolas.thiery.name/
34-
.. _libsemigroups: https://libsemigroups.github.io/libsemigroups/

docs/source/conf.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@
2525

2626
bibtex_bibfiles = ["libsemigroups.bib"]
2727

28+
rst_epilog = ""
29+
# Read link all targets from file
30+
with open("links.rst", encoding="utf-8") as f:
31+
rst_epilog += f.read()
32+
2833
autosummary_generate = True
2934
# We set this to True here, but remove "libsemigroups_pybind11\..*" from the doc
3035
# everywhere. This is done so we still get the submodule names, but not the
@@ -41,7 +46,7 @@
4146
# Use the version number of the installed project
4247
version = release = importlib.metadata.version(project)
4348
language = "python"
44-
exclude_patterns = ["_build", "_old"]
49+
exclude_patterns = ["_build", "_old", "links.rst"]
4550
pygments_style = "sphinx"
4651
highlight_language = "python"
4752
todo_include_todos = False

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ These are classes that permit the generic classes in libsemigroups_ to be
1515
used with arbitrary types, provided that the adapters are implemented for these
1616
types.
1717

18-
.. _libsemigroups: https://libsemigroups.github.io/libsemigroups/
1918

2019
.. toctree::
2120
:maxdepth: 1

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ Elements
1111
This page contains an overview summary of the functionality in libsemigroups_
1212
for defining elements of semigroups.
1313

14-
.. _libsemigroups: https://libsemigroups.github.io/libsemigroups/
1514

1615
.. toctree::
1716
:maxdepth: 1

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,3 @@ Full API
5050

5151
.. autofunction:: error_message_with_prefix
5252

53-
.. _libsemigroups: https://libsemigroups.github.io/libsemigroups/

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ further details see, for example, :any:`Runner.run_for` and
3737
The classes and modules in ``libsemigroups_pybind11`` for finitely presented
3838
semigroups and monoids are:
3939

40-
.. _libsemigroups: https://libsemigroups.github.io/libsemigroups/
4140

4241
.. toctree::
4342
:maxdepth: 1

docs/source/links.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. _libsemigroups: https://libsemigroups.github.io/libsemigroups/

docs/source/main-algorithms/kambites/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ On this page there are links to the documentation for the algorithms in
1313
authors of libsemigroups_; see :cite:`Kambites2009aa`,
1414
:cite:`Kambites2009ab`, and :cite:`Mitchell2021aa`.
1515

16-
.. _libsemigroups: https://libsemigroups.github.io/libsemigroups/
1716

1817
.. toctree::
1918
:maxdepth: 1

docs/source/main-algorithms/todd-coxeter/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ Similar to other places in libsemigroups_ it is possible to create a
2121
:any:`ToddCoxeter` object from a presentation consisting of strings or lists of
2222
integers.
2323

24-
.. _libsemigroups: https://libsemigroups.github.io/libsemigroups/
2524

2625
.. toctree::
2726
:maxdepth: 1

src/errors.cpp

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,6 @@ exception.
8888
:return: Whether :any:`LibsemigroupsError` messages contain a prefix about the
8989
C++ function that raised the exception.
9090
:rtype: bool
91-
92-
.. _libsemigroups: https://libsemigroups.github.io/libsemigroups/
9391
)pbdoc");
9492
m.def("error_message_with_prefix",
9593
py::overload_cast<bool>(&error_message_with_prefix),
@@ -107,7 +105,6 @@ exception. By default, this information is not included.
107105
about the C++ function that raised the exception.
108106
:type val: bool
109107
110-
.. _libsemigroups: https://libsemigroups.github.io/libsemigroups/
111108
)pbdoc");
112109
}
113110
} // namespace libsemigroups

0 commit comments

Comments
 (0)