#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 |
-------------------------------------------------+-------------------------
Changes (by nthiery):
* commit: 391f7ff599040fc4f3e306d95e9941a9e0127a3b =>
* branch: u/nthiery/16058-combinat-doc-index =>
Comment:
Replying to [comment:13 ncohen]:
> 1) I have no idea how I can obtain the result from your web page with
the branch you give.
Nothing special: checkout the branch and run `make doc` as usual.
> By the way, it does not apply on the latest rc0.
I merged the trivial conflict.
> 2) Look at that :
http://sage.math.washington.edu/home/nthiery/16058-doc/combinat/sage/combinat/counting.html
#sage-combinat-counting
> Or that :
http://sage.math.washington.edu/home/nthiery/16058-doc/combinat/sage/combinat/species/__init__.html
#sage-combinat-species
>
> All links are broken!
Thanks for spotting this. I had fumbled my query replace. It should be
fixed now. Well, I am recompiling Sage right now. I'll push / update
the web page shortly.
> That's a problem for a reference manual ...
No, really? Never thought about that :-)
> 3) Where are the combinatorial designs ?
Ah, yes, it somehow slipped out of the main index. Fixed. Thanks.
> 4) Those TODO will have to be removed before it is merged anywhere.
> Nicolas, it looks like your branch is not ready.
Of course.
> Could you review this ticket and create another one for yours?
Will do / done.
> 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.
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.
> Perhaps there is a pure-sphinx workaround ? I guess you asked Florent
about this too ?
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/*).
> Right now I have no idea how it works. If you create another ticket,
please explain that.
The only trick is in `src/doc/en/reference/combinat/index.rst` which
uses automodule to slurp in the documentation of `sage.combinat` which
itself is defined in `sage/combinat/__init__.py`
Other than that, this is just using standard ReST documentation.
--
Ticket URL: <http://trac.sagemath.org/ticket/16256#comment:4>
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.
