Reference manual: Show modularized sagelib packages separately #35734
Conversation
mkoeppe
changed the title
mkoeppe
force-pushed
the
doc_show_modularized_distributions_separately
branch
from
1fb1044 to
561c940
Compare
| the ``dot``, ``neato``, and ``twopi`` executables from the | ||
| ``graphviz`` package. | ||
| the :class:`dot`, :class:`neato`, and :class:`twopi` executables from the | ||
| :ref:`graphviz <spkg_graphviz>` package. |
src/doc/bootstrap
Outdated
|
|
||
| Packages of the Modularized Sage Library | ||
| ---------------------------------------- | ||
|
|
There was a problem hiding this comment.
How about "Distribution Packages of the Sage Library", now that "distribution package" is a standard term?
src/doc/bootstrap
Outdated
| echo "* :ref:\`spkg_$PKG_BASE\`" | ||
| done >> "$OUTPUT_INDEX" | ||
| cat >> "$OUTPUT_INDEX" <<EOF | ||
|
|
||
| Runtime-Detectable Features and Conditional Doctests | ||
| ---------------------------------------------------- |
There was a problem hiding this comment.
How about just "Features and Conditional Doctests" or "Features for Conditional Doctests" or even just "Features"?
We do not need to explain what a feature is in the title. Or do you need? If not, let's make the title short.
| sage/features/tdlib | ||
| sage/features/join_feature | ||
| sage/features/all | ||
|
|
There was a problem hiding this comment.
How about splitting feature facilities from features themselves? So sage/features, sage/features/join_feature, sage/features/all may be placed fore-front and then features afterwards.
There was a problem hiding this comment.
In a separate toctree then?
There was a problem hiding this comment.
Maybe. Perhaps we may later move them three out of this section if we could find a better place for them. But I have no idea right now.
There was a problem hiding this comment.
A good place for the three may be found in the section
Infrastructure > Programming Facilities > Test Framework
or a new section
Infrastructure > Programming Facilities > Features Framework (or Features Facility or just Features)
There was a problem hiding this comment.
Right, that's where they are coming from...
| External Packages | ||
| ================= | ||
| Features, Distributions, and External Packages | ||
| ============================================== | ||
|
|
There was a problem hiding this comment.
How about just "Packages and Features"?
And we list them in the order
- standard packages
- optional packages
- distribution packages
- features
- experimental packages (perhaps after features)
- all packages (I don't know what to do with this item. Maybe removed later)
|
Documentation preview for this PR (built with commit 9f3a128) is ready! 🎉 |
|
Thank you! |
📚 Description
Packages such as sagemath-categories are currently mixed with optional SPKGs in the reference guide.
We separate them out as a separate category.
We also move the section on
Features right next to the package list.#35749 and follow-ups will interlink these sections.
Preview:
📝 Checklist
⌛ Dependencies