#16256: Reorganize the documentation indexes into src/sage/combinat
-------------------------------------------------+-------------------------
       Reporter:  nthiery                        |        Owner:
           Type:  enhancement                    |       Status:  new
       Priority:  major                          |    Milestone:  sage-6.2
      Component:  documentation                  |   Resolution:
       Keywords:  combinatorics, thematic        |    Merged in:
  index, quickref                                |    Reviewers:
        Authors:  Nicolas M. ThiƩry              |  Work issues:
Report Upstream:  N/A                            |       Commit:
         Branch:                                 |     Stopgaps:
   Dependencies:  #16058                         |
-------------------------------------------------+-------------------------

Comment (by ncohen):

 > Ah, yes, it somehow slipped out of the main index. Fixed. Thanks.

 Can you be sure it is the only one ?

 > > You would also need to ask the release manager what he thinks of the
 script you have to run before generating the doc.
 >
 > There is no such script to be run.

 What is the meaning of this ?

 {{{
 +.. NOTE::
 +
 +   This is built automatically by running in src/sage/combinat::
 +
 +        for x in **/*.py*; do echo "    sage/combinat/"`echo $x | sed
 's/\.py.?$//'`; done >! /tmp/module_list
 }}}

 > At this point, when there is a new module to be added, you can edit by
 > hand module_list.rst (as we used to do in index.rst). Or just be lazy,
 > and use the shell commands listed there. The point is that this step
 > can be automatized and is meant to be so.


 Okay, whatever. If the addition above is not about a script that has to be
 run before generating the doc, it has nothing to do there.

 > Yes, the plan is certainly to have `module_list.rst` be built
 > automatically by sphinx. Something similar to the building of the
 > other sphinx autogenerated files (in
 > reference/combinat/sage/combinat/*).

 What is the point of having an index like that instead of the human-made
 index page, i.e. the one that is being worked on on this ticket ?

 Nathann

--
Ticket URL: <http://trac.sagemath.org/ticket/16256#comment:7>
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.

Reply via email to