Improve documentation of sage.features

[mkoeppe]

We also change the sporadic use of # optional: FEATURE by the more common # optional - FEATURE.

Depends on #32866
Depends on #32174

CC: @seblabbe @saraedum @kwankyu @slel

Component: documentation

Author: Matthias Koeppe

Branch/Commit: 547206c

Reviewer: Sébastien Labbé

Issue created by migration from https://trac.sagemath.org/ticket/32925

[mkoeppe]

Changed dependencies from #32866 to #32866, #32174

[mkoeppe]

Branch: u/mkoeppe/improve_documentation_of_sage_features

[mkoeppe]

Commit: d364333

[mkoeppe]

Last 10 new commits:

12a2507	src/sage/features/interfaces.py: Fix indentation in docstring
32dc210	Merge #32174
b8eb3ff	src/doc/en/reference/misc/index.rst: Move sage/features from 'Interactive' to 'Programming Utilities'
322e7c9	sage.features: Add headers for the reference manual
0b26010	src/doc/en/reference/misc/index.rst: Add sage.features.interfaces
dc954a7	src/sage/features/__init__.py: Fix doc markup
fe05309	sage.features.pkg_systems: New, move PackageSystem and subclasses here
b7cd28e	sage.features.sagemath: Improve docstring markup
bd59980	sage.features.mip_backends: Improve doc markup
d364333	sage.features: Improve doc markup

[slel]

comment:5

Some optional doctests are marked # optional: blah,
rather than # optional - blah as in the developer guide,
not sure whether that matters at all.

[mkoeppe]

comment:6

git grep 'sage:.*# *optional.*:' shows that both styles are used in the Sage library, but I think it's a good idea to make it uniform

[sagetrac-git]

Changed commit from d364333 to 547206c

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

547206c

Change "# optional: FEATURE" to "# optional - FEATURE"

[seblabbe]

Reviewer: Sébastien Labbé

[seblabbe]

comment:9

Works for me. Patchbot confirms that the documentation build fine.

[mkoeppe]

comment:10

Thank you!

[vbraun]

Changed branch from u/mkoeppe/improve_documentation_of_sage_features to 547206c