rst1 KB
reStructuredText Doc (RST source)
A reStructuredText document with directives, a code block, a note admonition, and a table — for testing docutils/Sphinx rendering, reST parsers, and editors.
Preview — first 49 linesrst
Novus Widget Documentation
==========================
A sample reStructuredText document for testing docutils, Sphinx, and editors.
Introduction
------------
The **Novus Widget** renders a configurable component. This file exercises reST
constructs: headings, lists, code blocks, and admonitions.
Installation
------------
Install from the package index::
pip install novus-widget
Quick start
-----------
#. Import the widget.
#. Create an instance.
#. Call ``render()``.
.. code-block:: python
from novus_widget import Widget
Widget("#app").render()
.. note::
Call ``render()`` after the page has loaded.
Options
-------
=========== ========= ==============================
Option Default Description
=========== ========= ==============================
theme light Colour theme (light or dark)
size md One of sm, md, lg
=========== ========= ==============================
License
-------
Free for any use. This text is synthetic sample content.
Specifications
- Format
- reStructuredText
- Features
- headings, code-block, note, table
What is a .rst file?
reStructuredText (reST) is a plain-text markup language from the Python community, used heavily for software documentation and by the Sphinx documentation generator. It uses indentation and simple punctuation for structure — headings, directives, roles, and cross-references. The .rst extension is standard.
How to use this file
Use an example .rst file to test reStructuredText parsers and editors, Sphinx or docutils rendering, and syntax highlighting.
Related files
- adocAsciiDoc Guide (ADOC source)An AsciiDoc getting-started guide with source blocks, an admonition, and a table — for testing AsciiDoc renderers (Asciidoctor), editors, and conversion to HTML/PDF.
- texLaTeX Article (TEX source)A small LaTeX article source with an abstract, a numbered equation (the Nyquist criterion), and a table — for testing LaTeX editors, syntax highlighters, and TeX-to-PDF pipelines.
- assASS Subtitles (Advanced SSA)An Advanced SubStation Alpha (.ass) subtitle with a styles section and three timed Dialogue events — the styled format libass renders — carrying the same captions as the SRT/VTT twins.
- sbvSBV Captions (YouTube)A YouTube SBV caption file — start,end timestamp lines followed by caption text — carrying the same three captions, for testing SBV parsers and YouTube caption import.
- ssaSSA Subtitles (SubStation Alpha)A SubStation Alpha (.ssa) subtitle — the predecessor of ASS — with a V4 styles section and timed Dialogue events, carrying the same captions, for testing SSA parsers and SSA-to-ASS upgrades.
- ttmlTTML Captions (DFXP)A TTML (Timed Text Markup Language / DFXP) caption document — timed XML paragraphs with a styling region — carrying the same captions, for testing XML caption parsers and IMSC players.
Generated by generation/docs_realworld.py. Free for any use, no attribution required — license.