Changes between Version 28 and Version 39 of Ticket #16256


Ignore:
Timestamp:
09/01/14 09:54:09 (6 years ago)
Author:
nthiery
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #16256

    • Property Commit changed from a23c12fafb58d03e371d47102bc490a7142ab7ab to 4ea19e8e8c4b00e9c64247b49fa4ce55c55647b8
  • Ticket #16256 – Description

    v28 v39  
    2121
    2222- Added the catalogs of permutation groups and matrix groups to the
    23   reference manual so that we can link to them.
     23  reference manual so that we can link to them. Fixed the doc title of
     24  the former.
     25
     26- Added a back link from the doc of sage.dynamics
    2427
    2528- Added (draft of) sage.combinat.quickref
    2629
     30This is a follow up to #16058.
     31
    2732End result browsable at ​http://sage.math.washington.edu/home/nthiery/sage/src/doc/output/html/en/reference/combinat/index.html
     33
     34Warning: see the note below about the current doc compilation glitch.
     35
     36*Discussion*
    2837
    2938One might argue that this reorganization of the documentation is not
     
    6473  - one can point to related things elsewhere in the source code
    6574
    66 TODO:
     75*TODO*
    6776
     77- Sphinx issue to be investigated: currently `make doc` fails upon
    6878- confirm that this is the right approach
    6979
     
    7484- checking that the links are functional
    7585
    76 - deciding on how to link to classes/functions: in the index we would
    77   want to have the title of the documentation of the class rather than
    78   the name of the class; or maybe both.
    79 
    8086- here or in a later ticket: finish automatizing the building of
    8187  module_list.rst.
    8288
    83 This is a follow up to #16058.
     89  first attempt, complaining about a broken link. One need to rerun
     90  it, and then the link is failed. This is probably just a glitch in
     91  how warnings are reported during the first pass of the reference
     92  manual compilation, but needs to be fixed before this ticket goes
     93  in.
     94
     95- Sphinx issue to be investigated: deciding on how to link to
     96  classes/functions: in the index we would want to have the title of
     97  the documentation of the class rather than the name of the class; or
     98  maybe both. It might be ok to stick to the class name for now until
     99  we find a good way to do this with Sphinx.
     100
     101- Sphinx issue to be investigated: how to crossrefs documents in the
     102  thematic tutorial. If there is no immediate way, it's possible to
     103  make a workaround for now.