Skip to content

Add contributor guidance for (sub)section reST header syntax #143

@jack-morrison

Description

@jack-morrison

reST allows a lot of flexibility in how (sub)sections are defined, but requires consistency of non-alphanumeric characters defining (sub)sections throughout a document.

This issue proposes that we define guidance for all reST documents in this repo in /contributing/.

To my knowledge, the Summit User Guide currently has the deepest subsection nesting, and should serve as the model:

The proposed order of characters is:
Asterisks
Equals
Dashes
Carets
Double Quotes
Underscores
Periods

(Asterisks necessarily placed above and below text. All others must be below and at least as long as the section title text.)

******
header
******

    section
    =======

        sub-section 1
        -------------

            sub-section 2
            ^^^^^^^^^^^^^

                sub-section 3
                """"""""""""""

                    sub-section 4
                    ______________

                        sub-section 5
                        ..............

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions