Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatic generation of the module list in the Sphinx documentation for sage.combinat #17421

Open
nthiery opened this issue Nov 30, 2014 · 1 comment

Comments

@nthiery
Copy link
Contributor

nthiery commented Nov 30, 2014

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.

CC: @nathanncohen @anneschilling @jpflori @mezzarobba

Component: documentation

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

@nthiery nthiery added this to the sage-6.5 milestone Nov 30, 2014
@nthiery

This comment has been minimized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants