Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 622 Bytes

File metadata and controls

27 lines (18 loc) · 622 Bytes

Contributing

Feel free to contribute to this guidelines by creating a pull request. If you are going to upload code snippets, make sure that they respect the PEP8 standard by running linters on it.

Some useful tools for contributing are:

  1. restview

    A viewer for ReStructuredText documents that renders them on the fly.

    pip install restview
    restview .

rST Guidelines

Headings

  • Use ------ for level 1 headings.
  • Use ====== for level 2 headings.
  • Use ^^^^^^ for level 3 headings.