Features for testing the presence of sphinx

class sage.features.sphinx.JupyterSphinx(*args, **kwds)[source]

Bases: PythonModule

A sage.features.Feature describing the presence of jupyter_sphinx.

It is provided by a standard package in the Sage distribution, but it can be disabled by configure --disable-doc and configure --disable-notebook.

EXAMPLES:

sage: from sage.features.sphinx import JupyterSphinx
sage: JupyterSphinx().is_present()                      # optional - jupyter_sphinx
FeatureTestResult('jupyter_sphinx', True)

>>> from sage.all import *
>>> from sage.features.sphinx import JupyterSphinx
>>> JupyterSphinx().is_present()                      # optional - jupyter_sphinx
FeatureTestResult('jupyter_sphinx', True)
class sage.features.sphinx.Sphinx(*args, **kwds)[source]

Bases: PythonModule

A sage.features.Feature describing the presence of Sphinx.

Sphinx is provided by a standard package in the Sage distribution, but it can be disabled by configure --disable-doc.

EXAMPLES:

sage: from sage.features.sphinx import Sphinx
sage: Sphinx().is_present()                                                     # needs sphinx
FeatureTestResult('sphinx', True)

>>> from sage.all import *
>>> from sage.features.sphinx import Sphinx
>>> Sphinx().is_present()                                                     # needs sphinx
FeatureTestResult('sphinx', True)
sage.features.sphinx.all_features()[source]