Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOC-499

toctrees don't play well with sections

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: High High
    • Guilin Release
    • Dublin Release
    • None
    • None

      version: master branch
      page: release/index

       

      I've just noticed that a mix of toctrees and sections generates a very weird  table of contents and possibly some conflicts.

      For example there is a section "Project Specific Release Notes" in index.rst and this is also a title for releaserepos.rst. Also it's hard to guess what is really a section and what is only a link to other subpage.

      Finally a link to releaserepos.rst appears as on a sublist of reporting bugs which is probably not the desired state.

      I'm not a an rst specialist but I've found some nice guideline:

      https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/MenuHierarchy.html

      where author clearly says that you shouldn't mix sections and toctrees

       

            eric.debeau eric.debeau
            kopasiak kopasiak
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved: