HDTutorial
EN
How to Document using Sphinx: Part 3—Formatting with reStructuredText

Playback starts YouTube’s embedded player (privacy-enhanced mode).

How to Document using Sphinx: Part 3—Formatting with reStructuredText

24,237 views November 12, 2019 13:05

Watch on YouTube
ChannelAudrey Tavares

Description from the creator

This video shows you how to format with the reStructuredText markup language.
Find the written guide to this tutorial here: techwritingmatters.com/

CONTENTS:
00:23 Creating a new file
01:16 Section titles
02:32 Adding emphasis (bold), italics and bullet points
02:59 Inserting an image
05:04 Adding a file to the toctree
05:26 Creating a hyperlink to another page
08:12 Linking to a section of a page
08:48 Creating separate toctrees
09:43 Embedding a YouTube video
10:28 Inserting an inline image
11:17 Creating an admonition box (warning, tip, caution etc.)

Resources:
Primer on reST: docutils.sourceforge.net/docs/user/rst/quicksta…
reST formatting: docutils.sourceforge.net/docs/ref/rst/restructu…

About this tutorial

Audrey Tavares published this 13:05 video tutorial on November 12, 2019. It has been watched 24,237 times on YouTube.

Category
Education
Duration
13:05
Published
November 12, 2019
Views
24,237
Likes
364

Tags

Share

This tutorial in other languages