Hi all,
Restructured text does not have pre-determined characters signifying
specific heading levels for headings in the documentation (e.g.,
chapters, sections, etc.). Python has the following convention [1]:
# with overline, for parts
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
", for paragraphs
In the python documentation, for example, book titles are done with #,
chapters are done with *, and then the = are used as sections.
In contrast to that, our thematic tutorials, for example, use = for the
book title, then = again for "chapter" titles, and then -, ^, and " for
successively smaller headings. Is there a reason why we didn't use #
for the book titles and * for the chapters?
If not, I propose we switch to the Python convention for the headings.
I'd be willing to make the patch for at least the thematic tutorials,
which I think (hope!) only really affects the top-level index files. If
people know an automatic way to make the switch, that would be great.
Thanks,
Jason
[1] http://sphinx.pocoo.org/rest.html#sections
--
To post to this group, send an email to sage-devel@googlegroups.com
To unsubscribe from this group, send an email to
sage-devel+unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URL: http://www.sagemath.org
