#17634: Rephrase the 'sage manuals' section of the developer manual
-------------------------+-------------------------------------------------
Reporter: | Owner:
ncohen | Status: positive_review
Type: | Milestone: sage-6.5
enhancement | Resolution:
Priority: major | Merged in:
Component: | Reviewers: Jeroen Demeyer, Karl-Dieter
documentation | Crisman
Keywords: | Work issues:
Authors: | Commit:
Nathann Cohen | cd6a363a5fb801d33dd24ffcf2835ba4c84129f7
Report Upstream: N/A | Stopgaps:
Branch: |
public/17634 |
Dependencies: |
-------------------------+-------------------------------------------------
Comment (by ncohen):
> I note that we now have
> > Thematic Tutorials v6.5.rc0 » Thematic tutorial document tree »
> which seems a little odd. Shouldn't it just be one level? Anyway, no
doubt this stems from one of the other tickets you mentioned.
I think that it is because of the `toctree.rst` files. If I understand
correctly, Sphinx will not detect a rst file as "indexed" unless it
appears in some toctree. The current methodology seems to be the following
1) Create a toctree.rst file that only contains a toctree
2) Point to toctree.rst in the index file where nobody notices it
This way the toctree appears as far as Sphinx is concerned, and we are
free to order the modules as we like instead of letting Sphinx do the job
with a big 'toctree'.
This being said, I would say that simplifying this could be possible by
just having this toctreee in the `index.rst` file and adding the 'hidden'
SphinX keyword.
Plus we would not have to carry a reference to the toctree.rst file when
we do not want one.
Thanks for your review,
Nathann
--
Ticket URL: <http://trac.sagemath.org/ticket/17634#comment:19>
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.
