Skip to content

Commit

Permalink
src/doc/bootstrap: In reference manual show modularized sagelib packa…
Browse files Browse the repository at this point in the history
…ges separately
  • Loading branch information
Matthias Koeppe committed Jun 5, 2023
1 parent 2f426a1 commit 1fb1044
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
2 changes: 1 addition & 1 deletion build/bin/sage-spkg-info
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 16 additions & 3 deletions src/doc/bootstrap
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,16 @@ Sage depends. It installs them automatically if it does not find
equivalent system packages.
EOF
for PKG_BASE in $(sage-package list --has-file SPKG.rst :standard: | sort); do
for PKG_BASE in $(sage-package list --has-file SPKG.rst :standard: | grep -v '^sagemath_' | sort); do
echo "* :ref:\`spkg_$PKG_BASE\`"
done >> "$OUTPUT_INDEX"
cat >> "$OUTPUT_INDEX" <<EOF
Packages of the Modularized Sage Library
----------------------------------------
EOF
for PKG_BASE in $(sage-package list --has-file SPKG.rst | grep '^sagemath_' | sort); do
echo "* :ref:\`spkg_$PKG_BASE\`"
done >> "$OUTPUT_INDEX"
cat >> "$OUTPUT_INDEX" <<EOF
Expand All @@ -112,7 +121,7 @@ For additional functionality, you can install some of the following
optional packages.
EOF
for PKG_BASE in $(sage-package list --has-file SPKG.rst :optional: | sort); do
for PKG_BASE in $(sage-package list --has-file SPKG.rst :optional: | grep -v '^sagemath_' | sort); do
echo "* :ref:\`spkg_$PKG_BASE\`"
done >> "$OUTPUT_INDEX"
cat >> "$OUTPUT_INDEX" <<EOF
Expand All @@ -125,7 +134,7 @@ Some packages that provide additional functionality are marked as
integration of these packages into the Sage distribution.
EOF
for PKG_BASE in $(sage-package list --has-file SPKG.rst :experimental: | sort); do
for PKG_BASE in $(sage-package list --has-file SPKG.rst :experimental: | grep -v '^sagemath_' | sort); do
echo "* :ref:\`spkg_$PKG_BASE\`"
done >> "$OUTPUT_INDEX"
cat >> "$OUTPUT_INDEX" <<EOF
Expand All @@ -150,6 +159,7 @@ Packages are in alphabetical order.
.. toctree::
:maxdepth: 1
.. default-role:: code
EOF
for PKG_BASE in $(sage-package list --has-file SPKG.rst | sort); do
PKG_SCRIPTS=build/pkgs/$PKG_BASE
Expand All @@ -160,3 +170,6 @@ for PKG_BASE in $(sage-package list --has-file SPKG.rst | sort); do
(echo ".. _spkg_$PKG_BASE:" && echo && OUTPUT_RST=1 sage-spkg-info $PKG_BASE) | sed -e "s|https://github.com/sagemath/sage/issues/\([0-9]*\)|:issue:\`\1\`|g" -e "s|https://arxiv.org/abs/cs/\([0-9]*\)|:arxiv:\`cs/\1\`|g" > "$OUTPUT_DIR"/$PKG_BASE.rst
echo >> "$OUTPUT_INDEX" " $PKG_BASE"
done
cat >> "$OUTPUT_INDEX" <<EOF
.. default-role::
EOF

0 comments on commit 1fb1044

Please sign in to comment.