Skip to content

Instantly share code, notes, and snippets.

@simkimsia
Last active October 25, 2023 04:00
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save simkimsia/756d8dfae2e42aa4608223f2640a04cd to your computer and use it in GitHub Desktop.
Save simkimsia/756d8dfae2e42aa4608223f2640a04cd to your computer and use it in GitHub Desktop.
.rst restructuredText template

Document Title Here

Author

Your Name

Date

Current Date

Version

1.0

Table of Contents

Abstract

This is a brief summary of what the document is about.

Introduction

Why this document exists.

Section 1: Getting Started

This is how to highlight code inline using two backticks.

To cite a link multiple times document and define the link once, see the next line and bottom of document.

See the rst cheatsheet for more details.

Sub-section 1.1: Overview

  • Point 1
  • Point 2

Sub-section 1.2: Installation

Generic code block

Code:

pip install package_name

Sub-section 1.3: Code snippets

Here's a Python code snippet:

def hello_world():
    print("Hello, world!")

Section 2: Usage

Sub-section 2.1: Basic Usage

You can add descriptions and code examples here.

Sub-section 2.2: Advanced Usage

Further details.

Conclusion

Wrap up your document here.

References

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment