rst

Documentation

Overview

Package rst is a reStructuredText parser producing a doctree.Element document tree, modeled on docutils.parsers.rst.states.

SCOPE (v1 — see [[go-docutils-org]] for the plan): sections (over/under lined titles), paragraphs, transitions, bullet lists, enumerated lists (arabic + '.' suffix only), field lists, definition lists, line blocks (flat, see lineblock.go for the un-implemented indent-nesting), doctest blocks, block quotes, literal blocks, comments, directives (captured structurally only, see explicit.go), hyperlink targets with reference resolution, footnotes, citations, substitution definitions (see explicit.go for all three — no numbering/symbol resolution, no substitution-value inlining), simple tables and GRID tables (see table.go and gridtable.go), and the inline markup in inline.go. NOT yet ported: option lists (see fieldlist.go for why they're deferred), indirect/anonymous hyperlink targets, per-directive semantics. Title- style consistency and enumerator-sequence validation are not enforced (docutils errors on inconsistent styles or skipped levels; this parser silently assigns a level instead).

Index

• func Parse(source string) *doctree.Element

Functions

func Parse

func Parse(source string) *doctree.Element

Parse parses reStructuredText source into a document tree.