#16256: Reorganize the documentation indexes into src/sage/combinat
-------------------------------------+-------------------------------------
Reporter: nthiery | Owner:
Type: enhancement | Status: needs_info
Priority: major | Milestone: sage-6.4
Component: documentation | Resolution:
Keywords: combinatorics, | Merged in:
thematic index, quickref | Reviewers:
Authors: Nicolas M. Thiéry | Work issues: gather comments by
Report Upstream: N/A | showing it around, and work on the
Branch: | listed TODO's
u/nthiery/reorganize_the_documentation_indexes_into_src_sage_combinat|
Commit:
Dependencies: #16058 | a23c12fafb58d03e371d47102bc490a7142ab7ab
| Stopgaps:
-------------------------------------+-------------------------------------
Comment (by nthiery):
Replying to [comment:17 ncohen]:
> If I understand correctly what this ticket is about, it rather goes
> against your goal, as it means to add more files to the
> documentation ...
Indeed, as a side effect, it adds a few files that were missing from
the reference manual; but this should not make a real difference.
> On the bright side, this ticket intends to do so many things
> requiring the input of so many persons that you can safely assume it
> will ... take time before anything is done `:-P`
Be my guest and show the example by doing your share :-)
The produced documentation for the sections about graphs and designs
with this branched applied can be found respectively in:
-
http://sage.math.washington.edu/home/nthiery/sage/src/doc/output/html/en/reference/combinat/index.html
-
http://sage.math.washington.edu/home/nthiery/sage/src/doc/output/html/en/reference/combinat/sage/combinat/designs/__init__.html
The sources are in the corresponding `__init__.py` files:
-
http://sage.math.washington.edu/home/nthiery/sage/src/sage/combinat/__init__.py
-
http://sage.math.washington.edu/home/nthiery/sage/src/sage/combinat/designs/__init__.py
(or just clone this branch as usual)
What's to be done:
- Checking that it looks good from the user point of view
- Choosing better entry points when appropriate
(e.g. sometime it's more natural to point directly to a class than
to the module defining it).
- Checking that it looks natural from the dev point of view
- Checking that nothing got lost in the operation
- Proofreading for typos
Thanks in advance,
Nicolas
--
Ticket URL: <http://trac.sagemath.org/ticket/16256#comment:27>
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.
