#17421: Automatic generation of the module list in the Sphinx documentation for
sage.combinat
---------------------------------+------------------------
Reporter: nthiery | Owner:
Type: enhancement | Status: new
Priority: major | Milestone: sage-6.5
Component: documentation | Resolution:
Keywords: | Merged in:
Authors: | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Commit:
Dependencies: | Stopgaps:
---------------------------------+------------------------
Description changed by nthiery:
Old description:
> Currently, the list of all modules to be included in the Sage reference
> manual needs to be maintained by hand. This is tedious, and modules often
> end up accidently missing in those lists. Besides, maintaining thoses
> lists is a common source of trivial but annoying conflicts.
>
> #16256 includes a first step toward automatizing the process in the
> context of sage.combinat (see
> src/doc/en/reference/combinat/module_list.rst. The purpose of this ticket
> is to finish the automatizing. This requires some Sphinx configuration /
> programming.
New description:
Currently, the list of all modules to be included in the Sage reference
manual needs to be maintained by hand. This is tedious, and modules often
end up accidently missing in those lists. Besides, maintaining thoses
lists is a common source of trivial but annoying conflicts.
#16256 includes a first step toward automatizing the process in the
context of sage.combinat (see
src/doc/en/reference/combinat/module_list.rst. The purpose of this
ticket is to finish the automatizing. This requires some Sphinx
configuration / programming.
Desirable features:
- Sorting the list alphabetically according to the module titles
rather than module names?
- Do not flatten the module hierarchical structure.
A natural approach would be to use the :glob: feature of toctree (see
http://sphinx-doc.org/markup/toctree.html). However, the globing is
done on the .rst files, not on the original modules. And those .rst
files are currently automatically generated only for the modules that
are listed in the toctree (see
`ReferenceSubBuilder.get_all_included_modules` in
`src/doc/common/builder.py`). So we need to break that loop.
--
--
Ticket URL: <http://trac.sagemath.org/ticket/17421#comment:1>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
