diff --git a/build/bin/sage-spkg-info b/build/bin/sage-spkg-info index 4e53139fa7e..d02b3ac347f 100755 --- a/build/bin/sage-spkg-info +++ b/build/bin/sage-spkg-info @@ -9,7 +9,7 @@ PKG_SCRIPTS="$SAGE_ROOT/build/pkgs/$PKG_BASE" for ext in rst txt; do SPKG_FILE="$PKG_SCRIPTS/SPKG.$ext" if [ -f "$SPKG_FILE" ]; then - cat "$SPKG_FILE" + sed "1,3s/^ *Sage: Open Source Mathematics Software:/$PKG_BASE:/" "$SPKG_FILE" break fi done diff --git a/src/doc/bootstrap b/src/doc/bootstrap index 6dd50fd5cec..be2168af064 100755 --- a/src/doc/bootstrap +++ b/src/doc/bootstrap @@ -89,8 +89,8 @@ fi OUTPUT_INDEX="$OUTPUT_DIR"/index.rst cat > "$OUTPUT_INDEX" <> "$OUTPUT_INDEX" cat >> "$OUTPUT_INDEX" <> "$OUTPUT_INDEX" +cat >> "$OUTPUT_INDEX" <> "$OUTPUT_INDEX" <> "$OUTPUT_INDEX" cat >> "$OUTPUT_INDEX" <> "$OUTPUT_INDEX" + cat >> "$OUTPUT_INDEX" <> "$OUTPUT_INDEX" < "$OUTPUT_DIR"/$PKG_BASE.rst echo >> "$OUTPUT_INDEX" " $PKG_BASE" done +cat >> "$OUTPUT_INDEX" <` is present and functional. EXAMPLES:: diff --git a/src/sage/features/cddlib.py b/src/sage/features/cddlib.py index 5badbd251c0..b37f0304948 100644 --- a/src/sage/features/cddlib.py +++ b/src/sage/features/cddlib.py @@ -17,7 +17,7 @@ class CddExecutable(Executable): r""" A :class:`~sage.features.Feature` describing the presence of an executable - which comes as a part of ``cddlib``. + which comes as a part of :ref:`cddlib `. EXAMPLES:: diff --git a/src/sage/features/csdp.py b/src/sage/features/csdp.py index 9c04779558c..e8aa55e50ea 100644 --- a/src/sage/features/csdp.py +++ b/src/sage/features/csdp.py @@ -25,7 +25,7 @@ class CSDP(Executable): r""" A :class:`~sage.features.Feature` which checks for the ``theta`` binary - of CSDP. + of :ref:`CSDP `. EXAMPLES:: diff --git a/src/sage/features/databases.py b/src/sage/features/databases.py index 7fa05ca099a..216dbb04af3 100644 --- a/src/sage/features/databases.py +++ b/src/sage/features/databases.py @@ -26,8 +26,8 @@ class DatabaseConwayPolynomials(StaticFile): r""" - A :class:`~sage.features.Feature` which describes the presence of Frank Luebeck's - database of Conway polynomials. + A :class:`~sage.features.Feature` which describes the presence of :ref:`Frank Luebeck's + database of Conway polynomials `. EXAMPLES:: @@ -60,8 +60,8 @@ def __init__(self): class DatabaseCremona(StaticFile): r""" - A :class:`~sage.features.Feature` which describes the presence of John Cremona's - database of elliptic curves. + A :class:`~sage.features.Feature` which describes the presence of :ref:`John Cremona's + database of elliptic curves `. INPUT: @@ -73,7 +73,7 @@ class DatabaseCremona(StaticFile): sage: from sage.features.databases import DatabaseCremona sage: DatabaseCremona('cremona_mini').is_present() FeatureTestResult('database_cremona_mini_ellcurve', True) - sage: DatabaseCremona().is_present() # optional - database_cremona_ellcurve + sage: DatabaseCremona().is_present() # optional - database_cremona_ellcurve FeatureTestResult('database_cremona_ellcurve', True) """ def __init__(self, name="cremona", spkg="database_cremona_ellcurve"): @@ -94,7 +94,8 @@ def __init__(self, name="cremona", spkg="database_cremona_ellcurve"): class DatabaseJones(StaticFile): r""" - A :class:`~sage.features.Feature` which describes the presence of John Jones's tables of number fields. + A :class:`~sage.features.Feature` which describes the presence of + :ref:`John Jones's tables of number fields `. EXAMPLES:: @@ -118,12 +119,13 @@ def __init__(self): class DatabaseKnotInfo(PythonModule): r""" - A :class:`~sage.features.Feature` which describes the presence of the databases at the + A :class:`~sage.features.Feature` which describes the presence of the + :ref:`package providing the KnotInfo and LinkInfo databases `. + + The homes of these databases are the web-pages `KnotInfo `__ and `LinkInfo `__. - - EXAMPLES:: sage: from sage.features.databases import DatabaseKnotInfo @@ -140,9 +142,13 @@ def __init__(self): """ PythonModule.__init__(self, 'database_knotinfo', spkg='database_knotinfo') + class DatabaseCubicHecke(PythonModule): r""" - A :class:`~sage.features.Feature` which describes the presence of the databases at the + A :class:`~sage.features.Feature` which describes the presence of the + :ref:`Cubic Hecke algebra database package `. + + The home of this database is the web-page `Cubic Hecke algebra on 4 strands `__ of Ivan Marin. @@ -162,10 +168,12 @@ def __init__(self): """ PythonModule.__init__(self, 'database_cubic_hecke', spkg='database_cubic_hecke') + class DatabaseReflexivePolytopes(StaticFile): r""" - A :class:`~sage.features.Feature` which describes the presence of the PALP database - of reflexive lattice polytopes. + A :class:`~sage.features.Feature` which describes the presence of the + :ref:`PALP databases of reflexive three-dimensional ` + and :ref:`four-dimensional lattice polytopes `. EXAMPLES:: diff --git a/src/sage/features/ffmpeg.py b/src/sage/features/ffmpeg.py index 681af26494c..36a23594162 100644 --- a/src/sage/features/ffmpeg.py +++ b/src/sage/features/ffmpeg.py @@ -15,7 +15,7 @@ class FFmpeg(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of ``ffmpeg`` + A :class:`~sage.features.Feature` describing the presence of :ref:`ffmpeg `. EXAMPLES:: diff --git a/src/sage/features/four_ti_2.py b/src/sage/features/four_ti_2.py index e898f601599..2af1c1e25d2 100644 --- a/src/sage/features/four_ti_2.py +++ b/src/sage/features/four_ti_2.py @@ -8,7 +8,7 @@ class FourTi2Executable(Executable): r""" - A :class:`~sage.features.Feature` for the 4ti2 executables. + A :class:`~sage.features.Feature` for the :ref:`4ti2 ` executables. """ def __init__(self, name): r""" @@ -27,7 +27,7 @@ def __init__(self, name): class FourTi2(JoinFeature): r""" - A :class:`~sage.features.Feature` describing the presence of the ``4ti2`` executables. + A :class:`~sage.features.Feature` describing the presence of all :ref:`4ti2 ` executables. EXAMPLES:: diff --git a/src/sage/features/gap.py b/src/sage/features/gap.py index 67c905a35c3..dad0e975804 100644 --- a/src/sage/features/gap.py +++ b/src/sage/features/gap.py @@ -1,5 +1,5 @@ r""" -Features for testing the presence of GAP packages +Features for testing the presence of the SageMath interfaces to ``gap`` and of GAP packages """ # ***************************************************************************** # Copyright (C) 2016 Julian RĂ¼th @@ -62,7 +62,7 @@ def _is_present(self): class sage__libs__gap(JoinFeature): r""" A :class:`sage.features.Feature` describing the presence of :mod:`sage.libs.gap` - (the library interface to GAP) and :mod:`sage.interfaces.gap` (the pexpect + (the library interface to :ref:`GAP `) and :mod:`sage.interfaces.gap` (the pexpect interface to GAP). By design, we do not distinguish between these two, in order to facilitate the conversion of code from the pexpect interface to the library interface. diff --git a/src/sage/features/gfan.py b/src/sage/features/gfan.py index d9a74db9e1b..040ea64ec5d 100644 --- a/src/sage/features/gfan.py +++ b/src/sage/features/gfan.py @@ -16,7 +16,7 @@ class GfanExecutable(Executable): r""" - A :class:`~sage.features.Feature` for the gfan executables. + A :class:`~sage.features.Feature` for the :ref:`gfan ` executables. """ def __init__(self, cmd=None): r""" diff --git a/src/sage/features/graph_generators.py b/src/sage/features/graph_generators.py index 3d484c59f6b..47c4557241c 100644 --- a/src/sage/features/graph_generators.py +++ b/src/sage/features/graph_generators.py @@ -1,5 +1,5 @@ r""" -Features for testing the presence of various graph generator programs +Features for testing the presence of graph generator programs ``benzene``, ``buckygen``, ``plantri`` """ # ***************************************************************************** @@ -23,7 +23,7 @@ class Plantri(Executable): r""" - A :class:`~sage.features.Feature` which checks for the ``plantri`` binary. + A :class:`~sage.features.Feature` which checks for the :ref:`plantri ` binary. EXAMPLES:: @@ -70,7 +70,7 @@ def is_functional(self): class Buckygen(Executable): r""" - A :class:`~sage.features.Feature` which checks for the ``buckygen`` binary. + A :class:`~sage.features.Feature` which checks for the :ref:`buckygen ` binary. EXAMPLES:: @@ -117,7 +117,7 @@ def is_functional(self): class Benzene(Executable): r""" - A :class:`~sage.features.Feature` which checks for the ``benzene`` + A :class:`~sage.features.Feature` which checks for the :ref:`benzene ` binary. EXAMPLES:: diff --git a/src/sage/features/graphviz.py b/src/sage/features/graphviz.py index 2105eda9d8c..abf9b7615fa 100644 --- a/src/sage/features/graphviz.py +++ b/src/sage/features/graphviz.py @@ -19,9 +19,9 @@ class dot(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of ``dot`` + A :class:`~sage.features.Feature` describing the presence of ``dot``. - EXAMPLES:: + TESTS:: sage: from sage.features.graphviz import dot sage: dot().is_present() # optional - graphviz @@ -42,9 +42,9 @@ def __init__(self): class neato(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of ``neato`` + A :class:`~sage.features.Feature` describing the presence of ``neato``. - EXAMPLES:: + TESTS: sage: from sage.features.graphviz import neato sage: neato().is_present() # optional - graphviz @@ -65,9 +65,9 @@ def __init__(self): class twopi(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of ``twopi`` + A :class:`~sage.features.Feature` describing the presence of ``twopi``. - EXAMPLES:: + TESTS:: sage: from sage.features.graphviz import twopi sage: twopi().is_present() # optional - graphviz @@ -89,8 +89,8 @@ def __init__(self): class Graphviz(JoinFeature): r""" A :class:`~sage.features.Feature` describing the presence of - the ``dot``, ``neato``, and ``twopi`` executables from the - ``graphviz`` package. + the :class:`dot`, :class:`neato`, and :class:`twopi` executables from the + :ref:`graphviz ` package. EXAMPLES:: diff --git a/src/sage/features/igraph.py b/src/sage/features/igraph.py index 6bb83294a95..bcf81f9cec7 100644 --- a/src/sage/features/igraph.py +++ b/src/sage/features/igraph.py @@ -19,7 +19,7 @@ class python_igraph(JoinFeature): r""" A :class:`sage.features.Feature` describing the presence of the - Python package ``igraph``. + Python package :ref:`igraph `. EXAMPLES:: diff --git a/src/sage/features/imagemagick.py b/src/sage/features/imagemagick.py index b7aa3aeb9a2..fceeed8b727 100644 --- a/src/sage/features/imagemagick.py +++ b/src/sage/features/imagemagick.py @@ -1,7 +1,7 @@ r""" Feature for testing the presence of ``imagemagick`` -Currently we only check for the presence of ``convert``. When needed other +Currently we only check for the presence of ``convert``. When needed, other commands like ``magick``, ``magick-script``, ``convert``, ``mogrify``, ``identify``, ``composite``, ``montage``, ``compare``, etc. could be also checked in this module. @@ -22,7 +22,7 @@ class Convert(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of ``convert`` + A :class:`~sage.features.Feature` describing the presence of ``convert``. EXAMPLES:: @@ -103,12 +103,13 @@ def is_functional(self): # The command seems functional return FeatureTestResult(self, True) + class ImageMagick(JoinFeature): r""" A :class:`~sage.features.Feature` describing the presence of - ``ImageMagick`` + :ref:`ImageMagick ` - Currently, only the availability of ``convert`` is checked. + Currently, only the availability of the :class:`convert` program is checked. EXAMPLES:: diff --git a/src/sage/features/interfaces.py b/src/sage/features/interfaces.py index e31e7b72d61..ddfc3b9b7ee 100644 --- a/src/sage/features/interfaces.py +++ b/src/sage/features/interfaces.py @@ -1,5 +1,5 @@ r""" -Features for testing whether interpreter interfaces are functional +Features for testing whether interpreter interfaces to ``magma``, ``maple``, ``mathematica`` etc. are functional """ # **************************************************************************** diff --git a/src/sage/features/kenzo.py b/src/sage/features/kenzo.py index 655602427b8..0060e6deb03 100644 --- a/src/sage/features/kenzo.py +++ b/src/sage/features/kenzo.py @@ -19,7 +19,7 @@ class Kenzo(Feature): r""" - A :class:`~sage.features.Feature` describing the presence of ``Kenzo``. + A :class:`~sage.features.Feature` describing the presence of :ref:`Kenzo `. EXAMPLES:: diff --git a/src/sage/features/latte.py b/src/sage/features/latte.py index e88752bd561..4df8b1cd586 100644 --- a/src/sage/features/latte.py +++ b/src/sage/features/latte.py @@ -24,7 +24,7 @@ class Latte_count(Executable): r""" - Feature for the executable ``count`` from the LattE suite. + Feature for the executable ``count`` from :ref:`LattE integrale `. """ def __init__(self): r""" @@ -41,7 +41,7 @@ def __init__(self): class Latte_integrate(Executable): r""" - Feature for the executable ``integrate`` from the LattE suite. + Feature for the executable ``integrate`` from :ref:`LattE integrale `. """ def __init__(self): r""" @@ -58,8 +58,8 @@ def __init__(self): class Latte(JoinFeature): r""" - A :class:`~sage.features.Feature` describing the presence of the ``LattE`` - binaries which comes as a part of ``latte_int``. + A :class:`~sage.features.Feature` describing the presence of excecutables + from :ref:`LattE integrale `. EXAMPLES:: diff --git a/src/sage/features/lrs.py b/src/sage/features/lrs.py index 501d1d371e7..6eb0a11b642 100644 --- a/src/sage/features/lrs.py +++ b/src/sage/features/lrs.py @@ -140,7 +140,7 @@ def is_functional(self): class Lrslib(JoinFeature): r""" A :class:`~sage.features.Feature` describing the presence of the executables - which comes as a part of ``lrslib``. + :class:`lrs ` and :class:`lrsnash ` provided by the :ref:`lrslib ` package. EXAMPLES:: diff --git a/src/sage/features/mcqd.py b/src/sage/features/mcqd.py index faf7ace441d..036e8fc727b 100644 --- a/src/sage/features/mcqd.py +++ b/src/sage/features/mcqd.py @@ -17,7 +17,8 @@ class Mcqd(JoinFeature): r""" - A :class:`~sage.features.Feature` describing the presence of :mod:`~sage.graphs.mcqd` + A :class:`~sage.features.Feature` describing the presence of the :mod:`~sage.graphs.mcqd` module, + which is the SageMath interface to the :ref:`mcqd ` library EXAMPLES:: diff --git a/src/sage/features/meataxe.py b/src/sage/features/meataxe.py index 78de1bdfe03..cc2a69cfeff 100644 --- a/src/sage/features/meataxe.py +++ b/src/sage/features/meataxe.py @@ -19,7 +19,8 @@ class Meataxe(JoinFeature): r""" - A :class:`~sage.features.Feature` describing the presence of ``meataxe``. + A :class:`~sage.features.Feature` describing the presence of the Sage modules + that depend on the :ref:`meataxe ` library. EXAMPLES:: diff --git a/src/sage/features/msolve.py b/src/sage/features/msolve.py index 557632ff500..31cc42e6176 100644 --- a/src/sage/features/msolve.py +++ b/src/sage/features/msolve.py @@ -24,12 +24,12 @@ class msolve(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of msolve + A :class:`~sage.features.Feature` describing the presence of :ref:`msolve `. EXAMPLES:: sage: from sage.features.msolve import msolve - sage: msolve().is_present() # optional - msolve + sage: msolve().is_present() # optional - msolve FeatureTestResult('msolve', True) """ def __init__(self): @@ -45,12 +45,12 @@ def __init__(self): def is_functional(self): r""" - Test if our installation of msolve is working + Test if our installation of msolve is working. - EXAMPLES:: + TESTS:: sage: from sage.features.msolve import msolve - sage: msolve().is_functional() # optional - msolve + sage: msolve().is_functional() # optional - msolve FeatureTestResult('msolve', True) """ msolve_out = subprocess.run(["msolve", "-h"], capture_output=True) diff --git a/src/sage/features/nauty.py b/src/sage/features/nauty.py index f3df59f4a9c..f57b5de2363 100644 --- a/src/sage/features/nauty.py +++ b/src/sage/features/nauty.py @@ -19,7 +19,7 @@ class NautyExecutable(Executable): r""" - A :class:`~sage.features.Feature` which checks for nauty executables. + A :class:`~sage.features.Feature` which checks for executables from the :ref:`nauty ` package. EXAMPLES:: @@ -43,7 +43,7 @@ def __init__(self, name): class Nauty(JoinFeature): r""" A :class:`~sage.features.Feature` describing the presence of the executables - which comes as a part of ``nauty``. + which comes as a part of :ref:`nauty `. EXAMPLES:: diff --git a/src/sage/features/normaliz.py b/src/sage/features/normaliz.py index acf8c9242c1..80b3891daf3 100644 --- a/src/sage/features/normaliz.py +++ b/src/sage/features/normaliz.py @@ -18,7 +18,7 @@ class PyNormaliz(JoinFeature): r""" A :class:`~sage.features.Feature` describing the presence of the - Python package ``PyNormaliz``. + Python package :ref:`PyNormaliz `. EXAMPLES:: diff --git a/src/sage/features/palp.py b/src/sage/features/palp.py index e9936f705ce..35758a0ecc7 100644 --- a/src/sage/features/palp.py +++ b/src/sage/features/palp.py @@ -17,11 +17,11 @@ class PalpExecutable(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of a PALP executable. + A :class:`~sage.features.Feature` describing the presence of a :ref:`PALP ` executable. INPUT: - - ``palpprog`` -- string, one of "poly", "class", "nef", "cws". + - ``palpprog`` -- string, one of ``"poly"``, ``"class"``, ``"nef"``, ``"cws"``. - ``suff`` -- string or ``None``. """ @@ -44,7 +44,7 @@ def __init__(self, palpprog, suff=None): class Palp(JoinFeature): r""" - A :class:`~sage.features.Feature` describing the presence of ``PALP``. + A :class:`~sage.features.Feature` describing the presence of :ref:`PALP `. """ def __init__(self): r""" diff --git a/src/sage/features/pandoc.py b/src/sage/features/pandoc.py index a00a2b6f8e4..00ee6055024 100644 --- a/src/sage/features/pandoc.py +++ b/src/sage/features/pandoc.py @@ -18,7 +18,7 @@ class Pandoc(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of ``pandoc`` + A :class:`~sage.features.Feature` describing the presence of :ref:`pandoc `. EXAMPLES:: diff --git a/src/sage/features/pdf2svg.py b/src/sage/features/pdf2svg.py index 2b60574fe85..98578ecb6a1 100644 --- a/src/sage/features/pdf2svg.py +++ b/src/sage/features/pdf2svg.py @@ -15,7 +15,7 @@ class pdf2svg(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of ``pdf2svg`` + A :class:`~sage.features.Feature` describing the presence of :ref:`pdf2svg `. EXAMPLES:: diff --git a/src/sage/features/phitigra.py b/src/sage/features/phitigra.py index 60ef8f46dde..6c1896bd8df 100644 --- a/src/sage/features/phitigra.py +++ b/src/sage/features/phitigra.py @@ -1,5 +1,5 @@ r""" -Check for phitigra +Check for ``phitigra`` """ # ***************************************************************************** @@ -16,7 +16,7 @@ class Phitigra(PythonModule): r""" - A :class:`sage.features.Feature` describing the presence of phitigra. + A :class:`sage.features.Feature` describing the presence of :ref:`phitigra `. Phitigra is provided by an optional package in the Sage distribution. diff --git a/src/sage/features/pkg_systems.py b/src/sage/features/pkg_systems.py index 334f8378050..8485fab0c7d 100644 --- a/src/sage/features/pkg_systems.py +++ b/src/sage/features/pkg_systems.py @@ -1,5 +1,5 @@ r""" -Features for testing the presence of package systems +Features for testing the presence of package systems ``sage_spkg``, ``conda``, ``pip``, ``debian``, ``fedora`` etc. """ # ***************************************************************************** diff --git a/src/sage/features/polymake.py b/src/sage/features/polymake.py index 6168c6c9978..d2b433b1c7f 100644 --- a/src/sage/features/polymake.py +++ b/src/sage/features/polymake.py @@ -1,5 +1,5 @@ r""" -Feature for testing the presence of the Python interface to polymake +Feature for testing the presence of ``jupymake``, the Python interface to polymake """ # ***************************************************************************** @@ -17,8 +17,8 @@ class JuPyMake(JoinFeature): r""" - A :class:`~sage.features.Feature` describing the presence of the :mod:`JuPyMake` - module, a Python interface to the polymake library. + A :class:`~sage.features.Feature` describing the presence of the :ref:`JuPyMake ` + module, a Python interface to the :ref:`polymake ` library. EXAMPLES:: diff --git a/src/sage/features/rubiks.py b/src/sage/features/rubiks.py index b9bd2f126f7..07250532cb6 100644 --- a/src/sage/features/rubiks.py +++ b/src/sage/features/rubiks.py @@ -20,7 +20,7 @@ class cu2(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of ``cu2`` + A :class:`~sage.features.Feature` describing the presence of ``cu2``. EXAMPLES:: @@ -42,7 +42,7 @@ def __init__(self): class size222(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of ``size222`` + A :class:`~sage.features.Feature` describing the presence of ``size222``. EXAMPLES:: @@ -64,7 +64,7 @@ def __init__(self): class optimal(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of ``optimal`` + A :class:`~sage.features.Feature` describing the presence of ``optimal``. EXAMPLES:: @@ -86,7 +86,7 @@ def __init__(self): class mcube(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of ``mcube`` + A :class:`~sage.features.Feature` describing the presence of ``mcube``. EXAMPLES:: @@ -108,7 +108,7 @@ def __init__(self): class dikcube(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of ``dikcube`` + A :class:`~sage.features.Feature` describing the presence of ``dikcube``. EXAMPLES:: @@ -130,7 +130,7 @@ def __init__(self): class cubex(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of ``cubex`` + A :class:`~sage.features.Feature` describing the presence of ``cubex``. EXAMPLES:: @@ -152,9 +152,9 @@ def __init__(self): class Rubiks(JoinFeature): r""" - A :class:`~sage.features.Feature` describing the presence of - ``cu2``, ``cubex``, ``dikcube``, ``mcube``, ``optimal``, and - ``size222``. + A :class:`~sage.features.Feature` describing the presence of the + :class:`cu2`, :class:`cubex`, :class:`dikcube`, :class:`mcube`, :class:`optimal`, and + :class:`size222` programs from the :ref:`rubiks ` package. EXAMPLES:: diff --git a/src/sage/features/singular.py b/src/sage/features/singular.py index c3bd3b6be03..5c83ff8a099 100644 --- a/src/sage/features/singular.py +++ b/src/sage/features/singular.py @@ -1,5 +1,5 @@ r""" -Features for testing the presence of Singular +Features for testing the presence of ``singular`` and the SageMath interfaces to it """ # ***************************************************************************** @@ -18,7 +18,7 @@ class Singular(Executable): r""" - A :class:`~sage.features.Feature` describing the presence of the Singular executable. + A :class:`~sage.features.Feature` describing the presence of the :ref:`singular ` executable. EXAMPLES:: diff --git a/src/sage/features/sphinx.py b/src/sage/features/sphinx.py index 44283765fd1..c83370cf28a 100644 --- a/src/sage/features/sphinx.py +++ b/src/sage/features/sphinx.py @@ -1,5 +1,5 @@ r""" -Check for Sphinx +Features for testing the presence of ``sphinx`` """ # ***************************************************************************** @@ -16,7 +16,7 @@ class Sphinx(PythonModule): r""" - A :class:`sage.features.Feature` describing the presence of Sphinx. + A :class:`sage.features.Feature` describing the presence of :ref:`Sphinx `. Sphinx is provided by a standard package in the Sage distribution, but it can be disabled by ``configure --disable-doc``. diff --git a/src/sage/features/tdlib.py b/src/sage/features/tdlib.py index afde40f7de7..128c056a49c 100644 --- a/src/sage/features/tdlib.py +++ b/src/sage/features/tdlib.py @@ -18,7 +18,7 @@ class Tdlib(JoinFeature): r""" - A :class:`~sage.features.Feature` describing the presence of the ``tdlib``. + A :class:`~sage.features.Feature` describing the presence of the SageMath interface to the :ref:`tdlib ` library. """ def __init__(self): r"""