#16058: Organize the index of the combinatorics section of the reference manual
-------------------------+-------------------------------------------------
Reporter: | Owner:
ncohen | Status: needs_review
Type: | Milestone: sage-6.2
enhancement | Resolution:
Priority: major | Merged in:
Component: | Reviewers:
combinatorics | Work issues:
Keywords: | Commit:
Authors: | 4b5cb2beed23b92bf27529fca72e89db8754f6d5
Report Upstream: N/A | Stopgaps:
Branch: |
public/16058 |
Dependencies: |
-------------------------+-------------------------------------------------
Comment (by nthiery):
What the heck??? Why didn't my advertising for all the hard work I had put
on my branch last week-end end up here? I must say I was surprised not to
get feedback ...
Oh well. Here is my commit log:
{{{
Trac 16058: Reorganize the documentation indexes into
src/sage/combinat
- For example, the thematic index
src/doc/en/reference/combinat/crystals.rst is now in:
src/sage/combinat/crystals/__init__.py and is accessible through
sage.combinat.crystals?
(to be discussed: should this be put in all.py instead?)
- What's left in doc/en/reference/combinat is basically autogenerated.
(the building of module_list.rst there still needs to be regenerated
by hand)
- All p/cython files in sage/combinat/ are now included in the
reference manual
- Improved thematic indexes
- New thematic indexes: algebraic_combinatorics, catalog_partitions,
counting, enumerated_sets
- Fixed some documentation syntax glitches here and there
- Added the catalogs of permutation groups and matrix groups to the
reference manual so that we can link to them.
- Draft of sage.combinat.quickref
TODO:
- proof reading
- choosing the right entry points
- checking that the links are functional
- deciding on how to link to classes/functions (in the index we would
want to have the title of the documentation of the class rather than
the name of the class. Or maybe both).
}}}
Please have a look at u/nthiery/16058-combinat-doc-index, and at the
current end-result:
http://sage.math.washington.edu/home/nthiery/16058-doc/combinat/index.html
One might argue that this reorganization of the documentation is not
consistent with what's done elsewhere in the manual. Indeed. I believe
sage.combinat is a good spot to explore better ways to organize the
documentation. I also believe that this new way is more local,
simpler, and more flexible. It might benefit from a bit more support
from sphinx though
If you think the change is a bit radical and you prefer merging the
current official branch as it is now, and postponing mine to a later
ticket, that's fine with me.
Cheers,
Nicolas
--
Ticket URL: <http://trac.sagemath.org/ticket/16058#comment:12>
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.
