Trac #29745: Clean up SPKG.rst for packages

This is a follow-up to #29633: clean up typos and typesetting issues in
various SPKG.rst files.

See also: #29655 - Improve build/pkgs/*/SPKG.rst

URL: https://trac.sagemath.org/29745
Reported by: jhpalmieri
Ticket author(s): John Palmieri
Reviewer(s): Matthias Koeppe

build/pkgs/4ti2/SPKG.rst

@@ -16,7 +16,8 @@ License
 Upstream Contact
 ----------------
 
-Raymond Hemmecke, TU Munich, Germany Matthias Köppe, UC Davis, CA, USA
+- Raymond Hemmecke, TU Munich, Germany
+- Matthias Köppe, UC Davis, CA, USA
 
 Dependencies
 ------------

build/pkgs/atlas/SPKG.rst

@@ -28,17 +28,14 @@ Special Update/Build Instructions
 ---------------------------------
 
 -  src/lapack-x.y.z.tgz: The netlib lapack tarball. If you update this,
-
    make sure you also update the LAPACK_TARBALL variable in
    spkg-install.
 
 -  src/ATLAS-lib: We are using a dummy autotools/libtools project
-
    to repack the static ATLAS libraries into shared libraries.
 
 -  src/ARCHS: We ship some archdef tarballs to speed ATLAS build.
 -  spkg-install: If you update atlas to a new version make sure that the
-
    ATLAS_OSTYPE, ATLAS_MACHTYPE, and ATLAS_ISAEXT variables in
    spkg-install remain in sync with atlas' CONFIG/include/atlconf.h
 
@@ -49,20 +46,17 @@ Patches
 ~~~~~~~
 
 -  patches/detect.patch: Fix Itanium2 support on modern
-
    RHEL 5 and SLES 10 systems, work around -m64 issue on Itanium2,
    and correctly detect number and speed of CPUs on a bunch of systems.
 
 -  patches/arm_hard_floats.patch: make sure soft floats are not enforced
    on ARM.
 -  patches/Makefile.patch: fix clean target.
 -  patches/do_not_force_mutex.patch: always use assembly over mutex
-
    since the mutex version fails to build a shared library. See #15045
    for details.
 
 -  patches/glibc_scanf_workaround.patch: Workaround for the scanf bug
-
    in glibc-2.18 that breaks the atlas auto-tuning system.
 
 Configuration
@@ -97,11 +91,9 @@ The package can be configured via three environment variables:
    In addition, you can also set
 
 -  SAGE_ATLAS_ARCH=fast picks defaults for a modern (2-3 year old)
-
    CPU of your processor line, and
 
 -  SAGE_ATLAS_ARCH=base picks defaults that should work for a ~10
-
    year old CPU.
 
    For example,
@@ -111,5 +103,4 @@ The package can be configured via three environment variables:
    would be appropriate for a Core i7 CPU.
 
 -  If SAGE_ATLAS_SAVE_ARCHDEF = is given, then a new archdef
-
    file is created and saved to the given path.

build/pkgs/awali/SPKG.rst

@@ -9,7 +9,7 @@ finite state machines. Here finite state machines is to be understood in
 the broadest possible sense: finite automata with output — often called
 transducers then — or even more generally finite automata with
 multiplicity, that is, automata that not only accept, or recognize,
-sequences of symbols but compute for every such sequence a \`value' that
+sequences of symbols but compute for every such sequence a 'value' that
 is associated with it and which can be taken in any semiring. Hence the
 variety of situations that can thus be modellized.
 

build/pkgs/benzene/SPKG.rst

@@ -12,8 +12,8 @@ fusenes that are subgraphs of the hexagonal lattice.
 License
 -------
 
-Benzene is licensed under the GNU General Public License v2 or later (
-June 2007 )
+Benzene is licensed under the GNU General Public License v2 or later
+(June 2007)
 
 
 Upstream Contact

build/pkgs/bzip2/SPKG.rst

@@ -31,8 +31,9 @@ None
 Special Update/Build Instructions
 ---------------------------------
 
-This package must not be bzip2 compressed, so create it using tar c
-bzip2-1.0.6 \| gzip --best >bzip2-1.0.6.spkg
+This package must not be bzip2 compressed, so create it using ::
+
+    tar c bzip2-1.0.6 | gzip --best >bzip2-1.0.6.spkg
 
 The build system has been autotoolized based on a patch by the Suse folk
 at

build/pkgs/combinatorial_designs/SPKG.rst

@@ -8,9 +8,7 @@ Description
 Data for Combinatorial Designs. Current content:
 
 -  The table of MOLS (10 000 integers) from the Handbook of
-   Combinatorial
-
-   Designs, 2ed.
+   Combinatorial Designs, 2ed.
 
 License
 -------

build/pkgs/compilerwrapper/SPKG.rst

@@ -18,8 +18,8 @@ GPL v2+
 Upstream Contact
 ----------------
 
-https://bitbucket.org/vbraun/compilerwrapper Volker Braun
-<vbraun.name@gmail.com>
+- https://bitbucket.org/vbraun/compilerwrapper
+- Volker Braun <vbraun.name@gmail.com>
 
 Dependencies
 ------------

build/pkgs/coxeter3/SPKG.rst

@@ -46,8 +46,9 @@ None
 Special Update/Build Instructions
 ---------------------------------
 
-The source package was created by running
+The source package was created by running ::
 
-commit=8ac9c71723c8ca57a836d6381aed125261e44e9e git clone
-https://github.com/tscrim/coxeter.git cd coxeter git archive $commit
-\|bzip2 --best >coxeter-$commit.tar.bz2
+    commit=8ac9c71723c8ca57a836d6381aed125261e44e9e
+    git clone https://github.com/tscrim/coxeter.git
+    cd coxeter
+    git archive $commit | bzip2 --best >coxeter-$commit.tar.bz2

build/pkgs/csdp/SPKG.rst

@@ -48,6 +48,5 @@ Detailed steps to build the spkg are as follows. You need
 With these ready:
 
 -  ./spkg-src
--  copy the resulting csdp-.tar.gz to SAGE_ROOT/upstream,
-
+-  copy the resulting csdp-<version>.tar.gz to SAGE_ROOT/upstream,
    or somewhere else appropriate

build/pkgs/cvxopt/SPKG.rst

@@ -42,18 +42,15 @@ Special Update/Build Instructions
 -  cvxopt.h.patch: Fix building with GCC on Solaris.
 
 -  setup.py.patch: look for libraries and includes in $SAGE_LOCAL
-
    instead of /usr. Add fortran, blas,... libraries if needed.
    Build with GSL and GLPK support.
 
 -  remove doc/html/, as it can be rebuild by invoking 'sage -sh' and
-
    running 'make html' in doc/
 
 -  TODO: Add more tests in spkg-check
 
 -  TODO: one might want to enhance the code to allow other Sage
-
    random sources, at the moment only GSL is used in CVXOPT-1.1.3
    spkg, apparently it will need an unclear to me "with seed(..)"
    construct.

build/pkgs/d3js/SPKG.rst

@@ -17,8 +17,8 @@ BSD 3-Clause License
 Upstream Contact
 ----------------
 
-Author: Mike Bostock (http://bost.ocks.org/mike/) Home page:
-http://d3js.org/
+- Author: Mike Bostock (http://bost.ocks.org/mike/)
+- Home page: http://d3js.org/
 
 Dependencies
 ------------

build/pkgs/database_cremona_ellcurve/SPKG.rst

@@ -41,11 +41,11 @@ Get an up-to-date copy of the git repository ecdata from
 https://github.com/JohnCremona/ecdata.
 
 If the cremona database has already been installed, remove
-\`SAGE_DATA/cremona/cremona.db`. Then run
+``SAGE_DATA/cremona/cremona.db``. Then run
 
 The build script expects to find the files in subfolders allcurves,
 allgens, degphi and allbsd of the ecdata folder. It extracts them and
 builds the new cremona.db file from the contents.
 
-Finally, copy \`SAGE_DATA/cremona/cremona.db\` to the src directory of
+Finally, copy ``SAGE_DATA/cremona/cremona.db`` to the src directory of
 the spkg.

build/pkgs/database_mutation_class/SPKG.rst

@@ -5,22 +5,21 @@ Mutation class database
 Description
 -----------
 
-   Contains a database of all exceptional mutation classes of quivers.
+Contains a database of all exceptional mutation classes of quivers.
 
-   Every file in the database is of the form
-   \``mutation_classes_n.dig6`\` for some \``n`\` and
+Every file in the database is of the form
+``mutation_classes_n.dig6`` for some ``n`` and
 
--  contains a \``cPickle.dump`\` of a dictionary where
+-  contains a ``cPickle.dump`` of a dictionary where
 -  the keys are tuples representing irreducible exceptional quiver
-   mutation types of rank \``n``, and
+   mutation types of rank ``n``, and
 -  the values are all quivers in the given mutation class stored in
-   canonical form as \``(dig6,edges)`\` where
--  \``dig6`\` is the dig6 data of the given \``DiGraph``, and
--  \``edges`\` are the non-simply-laced edges thereof.
+   canonical form as ``(dig6,edges)`` where
+-  ``dig6`` is the dig6 data of the given ``DiGraph``, and
+-  ``edges`` are the non-simply-laced edges thereof.
 -  is obtained by running the function
 
-   \``sage.combinat.cluster_algebra_quiver.quiver_mutation_type._save_data_dig6(n,
-   types='Exceptional', verbose=False)`\`
+   ``sage.combinat.cluster_algebra_quiver.quiver_mutation_type._save_data_dig6(n, types='Exceptional', verbose=False)``
 
 
 SPKG Maintainers

build/pkgs/database_stein_watkins/SPKG.rst

@@ -23,4 +23,4 @@ None
 Patches
 ~~~~~~~
 
--  None
+None

build/pkgs/database_stein_watkins_mini/SPKG.rst

@@ -23,4 +23,4 @@ None
 Patches
 ~~~~~~~
 
--  None
+None

build/pkgs/database_symbolic_data/SPKG.rst

@@ -8,7 +8,6 @@ The SymbolicData project is set out
 
 -  to develop concepts and tools for profiling, testing and benchmarking
    Computer Algebra Software
-
    (CAS) and
 
 -  to collect and interlink relevant data and activities from different

build/pkgs/ecl/SPKG.rst

@@ -45,31 +45,26 @@ Special Update/Build Instructions
 ---------------------------------
 
 -  As autotools need to be run after most of the patches are applied,
-
    we do all the patching in spkg-source.
 
 -  Deleting the following directories saves space: without doing
-
    this, the tarball can grow from under 3 megabytes to more than 7
    megabytes. Deleting these files is done automatically by the
-   \`spkg-src\` script.
+   ``spkg-src`` script.
 
 -  The directory msvc
 -  The directory src/gc-unstable
 -  The directory src/gmp
 -  The directory src/libffi
 -  Note: for the time being, ECL is built single threaded library as it
-
    seems to interact badly with the pexpect interface and Sage's signal
    handling when built multithreaded.
 
 -  Do NOT quote SAGE_LOCAL when setting CPPFLAGS and/or LDFLAGS,
-
    in spkg-install as this caused the build to break. See
    http://trac.sagemath.org/sage_trac/ticket/10187#comment:117
 
 -  TODO: Add the ECL test suite, and an spkg-check file to run it.
 -  TODO: Make ECL use Sage's Boehm GC on MacOS X as well (but perhaps
-
    put some changes from ECL's into Sage's Boehm GC), then remove
    the src/src/gc directory, too.

build/pkgs/ecm/SPKG.rst

@@ -30,11 +30,9 @@ Special Update/Build Instructions
 ---------------------------------
 
 -  GMP-ECM comes with a self-tuning feature; we could support
-
    that as an option ($SAGE_TUNE_*=yes) in the future.
 
 -  ECM currently does not (by itself) use the CC and CFLAGS settings
-
    from 'gmp.h' since we pass (other) options in CFLAGS, and CC is set
    by Sage and might got set by the user. We now at least partially fix
    that
@@ -56,13 +54,11 @@ Special Update/Build Instructions
    option isn't used on anything other than x86 / x86_64.)
 
 -  We currently work around a linker bug on MacOS X 10.5 PPC (with
-
    GCC 4.2.1) which breaks 'configure' if debug symbols are enabled.
    This \*might\* get fixed in later upstream releases.
 
--  We could save some space by removing the \`src/build.vc10/\`
+-  We could save some space by removing the ``src/build.vc10/``
    directory which
-
    isn't used in Sage. (It gets probably more worth in case also
    directories /
    files for later versions of Microsoft Visual C get added.)

build/pkgs/elliptic_curves/SPKG.rst

@@ -7,7 +7,6 @@ Description
 Includes two databases:
 
 -  A small subset of John Cremona's database of elliptic curves up
-
    to conductor 10000.
 
 -  William Stein's database of interesting curves

build/pkgs/freetype/SPKG.rst

@@ -6,20 +6,20 @@ Description
 
 From the documentation:
 
-> FreeType is a software font engine that is designed to be small, >
-efficient, highly customizable, and portable while capable of >
-producing high-quality output (glyph images). It can be used in >
-graphics libraries, display servers, font conversion tools, > text image
+FreeType is a software font engine that is designed to be small,
+efficient, highly customizable, and portable while capable of
+producing high-quality output (glyph images). It can be used in
+graphics libraries, display servers, font conversion tools, text image
 generation tools, and many other products as well.
 
-> Note that FreeType is a font service and doesn't provide APIs to >
-perform higher-level features like text layout or graphics processing >
-(e.g., colored text rendering, ‘hollowing’, etc.). However, it greatly >
-simplifies these tasks by providing a simple, easy to use, and uniform >
+Note that FreeType is a font service and doesn't provide APIs to
+perform higher-level features like text layout or graphics processing
+(e.g., colored text rendering, ‘hollowing’, etc.). However, it greatly
+simplifies these tasks by providing a simple, easy to use, and uniform
 interface to access the content of font files.
 
-> Please note that ‘FreeType’ is also called ‘FreeType 2’, to >
-distinguish it from the old, deprecated ‘FreeType 1’ library, > a
+Please note that ‘FreeType’ is also called ‘FreeType 2’, to
+distinguish it from the old, deprecated ‘FreeType 1’ library, a
 predecessor no longer maintained and supported.
 
 The package in Sage is called freetype (in lowercase).
@@ -32,8 +32,8 @@ License
 
 From the documentation:
 
-> FreeType is released under two open-source licenses: our own BSD-like
-> FreeType License and the GNU Public License, Version 2. It can thus >
+FreeType is released under two open-source licenses: our own BSD-like
+FreeType License and the GNU Public License, Version 2. It can thus
 be used by any kind of projects, be they proprietary or not.
 
 
@@ -42,10 +42,11 @@ Upstream Contact
 
 -  home: https://www.freetype.org
 -  repo:
--  official: http://git.savannah.gnu.org/cgit/freetype
--  mirror: https://github.com/aseprite/freetype2/
+
+   -  official: http://git.savannah.gnu.org/cgit/freetype
+   -  mirror: https://github.com/aseprite/freetype2/
 
 Dependencies
 ------------
 
-See the \`dependencies\` file.
+See the ``dependencies`` file.

build/pkgs/future/SPKG.rst

@@ -12,16 +12,16 @@ support both Python 2 and Python 3 with minimal overhead.
 
 It is designed to be used as follows:
 
-from \__future_\_ import (absolute_import, division,
+.. CODE-BLOCK:: python
 
-   print_function, unicode_literals)
+   from __future__ import (absolute_import, division,
+                             print_function, unicode_literals)
 
-from builtins import (
-
-   bytes, dict, int, list, object, range, str,
-   ascii, chr, hex, input, next, oct, open,
-   pow, round, super,
-   filter, map, zip)
+   from builtins import (
+       bytes, dict, int, list, object, range, str,
+       ascii, chr, hex, input, next, oct, open,
+       pow, round, super,
+       filter, map, zip)
 
 followed by predominantly standard, idiomatic Python 3 code that then
 runs similarly on Python 2.6/2.7 and Python 3.3+.