sage.features: Add headers for the reference manual

src/doc/en/reference/misc/index.rst

@@ -148,8 +148,8 @@ Features
    :maxdepth: 1
 
    sage/features
-   sage/features/all
    sage/features/join_feature
+   sage/features/all
    sage/features/sagemath
    sage/features/bliss
    sage/features/csdp

src/sage/features/all.py

@@ -1,3 +1,6 @@
+r"""
+Enumeration of all defined features
+"""
 
 def all_features():
     r"""

src/sage/features/bliss.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Checks for bliss
+Features for testing the presence of ``bliss``
 """
 from . import CythonFeature, PythonModule
 from .join_feature import JoinFeature

src/sage/features/csdp.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Testing for CSDP at runtime
+Feature for testing the presence of ``csdp``
 """
 
 import os

src/sage/features/databases.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Testing for databases at runtime
+Features for testing the presence of various databases
 """
 
 

src/sage/features/dvipng.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Check for dvipng
+Feature for testing the presence of ``dvipng``
 """
 # ****************************************************************************
 #       Copyright (C) 2021 Sebastien Labbe <slabqc@gmail.com>

src/sage/features/fes.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Checks for FES
+Features for testing the presence of ``fes``
 """
 
 from . import CythonFeature, PythonModule

src/sage/features/ffmpeg.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Check for FFmpeg
+Feature for testing the presence of ``ffmpeg``
 """
 # ****************************************************************************
 #       Copyright (C) 2018 Sebastien Labbe <slabqc@gmail.com>

src/sage/features/four_ti_2.py

@@ -1,3 +1,7 @@
+r"""
+Features for testing the presence of ``4ti2``
+"""
+
 from . import Executable
 from .join_feature import JoinFeature
 

src/sage/features/gap.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Check for GAP features
+Features for testing the presence of GAP packages
 """
 
 from . import Feature, FeatureTestResult

src/sage/features/graph_generators.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Check various graph generator programs
+Features for testing the presence of various graph generator programs
 """
 
 import os

src/sage/features/graphviz.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Check for graphviz
+Features for testing the presence of ``graphviz``
 """
 # ****************************************************************************
 #       Copyright (C) 2018 Sebastien Labbe <slabqc@gmail.com>

src/sage/features/imagemagick.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Check for imagemagick
+Feature for testing the presence of ``imagemagick``
 
 Currently we only check for the presence of ``convert``. When needed other
 commands like ``magick``, ``magick-script``, ``convert``, ``mogrify``,

src/sage/features/internet.py

@@ -1,3 +1,7 @@
+r"""
+Feature for testing if the Internet is available
+"""
+
 from . import Feature, FeatureTestResult
 
 

src/sage/features/kenzo.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Check for Kenzo
+Feature for testing the presence of ``kenzo``
 """
 
 from . import Feature, FeatureTestResult

src/sage/features/latex.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Check for pdflatex and equivalent programs
+Features for testing the presence of ``latex`` and equivalent programs
 """
 # ****************************************************************************
 #       Copyright (C) 2021 Sebastien Labbe <slabqc@gmail.com>

src/sage/features/latte.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Check for LattE
+Features for testing the presence of ``latte_int``
 """
 from . import Executable
 from .join_feature import JoinFeature

src/sage/features/lrs.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Check for lrs
+Feature for testing the presence of ``lrslib``
 """
 
 import os

src/sage/features/mcqd.py

@@ -1,3 +1,7 @@
+r"""
+Features for testing the presence of ``mcqd``
+"""
+
 from . import PythonModule
 from .join_feature import JoinFeature
 

src/sage/features/meataxe.py

@@ -1,10 +1,14 @@
+r"""
+Feature for testing the presence of ``meataxe``
+"""
+
 from . import PythonModule
 from .join_feature import JoinFeature
 
 
 class Meataxe(JoinFeature):
     r"""
-    A :class:`sage.features.Feature` describing the presence of ``MeatAxe``.
+    A :class:`sage.features.Feature` describing the presence of ``meataxe``.
 
     EXAMPLES::
 

src/sage/features/mip_backends.py

@@ -1,3 +1,7 @@
+r"""
+Features for testing the presence of :class:`MixedIntegerLinearProgram` backends
+"""
+
 from . import Feature, FeatureTestResult
 from .join_feature import JoinFeature
 

src/sage/features/normaliz.py

@@ -1,5 +1,5 @@
 r"""
-Check for pynormaliz
+Feature for testing the presence of ``pynormaliz``
 """
 from . import PythonModule
 from .join_feature import JoinFeature

src/sage/features/pandoc.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Check for pandoc
+Feature for testing the presence of ``pandoc``
 """
 # ****************************************************************************
 #       Copyright (C) 2018 Thierry Monteil <sage!lma.metelu.net>

src/sage/features/pdf2svg.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Check for pdf2svg
+Feature for testing the presence of ``pdf2svg``
 """
 # ****************************************************************************
 #       Copyright (C) 2021 Sebastien Labbe <slabqc@gmail.com>

src/sage/features/polymake.py

@@ -1,3 +1,6 @@
+r"""
+Feature for testing the presence of the Python interface to polymake
+"""
 from . import PythonModule
 from .join_feature import JoinFeature
 

src/sage/features/rubiks.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 r"""
-Check for rubiks
+Features for testing the presence of ``rubiks``
 """
 # ****************************************************************************
 # This program is free software: you can redistribute it and/or modify

src/sage/features/sagemath.py

@@ -1,5 +1,5 @@
 r"""
-Check for SageMath Python modules
+Features for testing the presence of Python modules in the Sage library
 """
 from . import PythonModule
 from .join_feature import JoinFeature

src/sage/features/tdlib.py

@@ -1,3 +1,7 @@
+r"""
+Features for testing the presence of ``tdlib``
+"""
+
 from . import PythonModule
 from .join_feature import JoinFeature