reStructuredText

This topic brings together 6 pages across the manual:

6 Tasks

• Automatically insert data into a reStructuredText file

  Task

  Learning path: 6. Automation & legacy techniques›Jinja

  Automatically insert product data into reStructuredText documentation with Python - generate per-product version lists from structured data files.

• Automatically insert SQL data into a reStructuredText file

  Task

  Learning path: 6. Automation & legacy techniques›Python

  Create a product database with Python and SQLite, then automatically generate formatted reStructuredText documentation from the data - a practical docs-as-code tutorial.

• Create different documents from the same ReST sources (conditional text)

  Task

  Learning path: 6. Automation & legacy techniques

  Generate multiple document variants - user guide, admin guide, lite edition - from the same reStructuredText sources using Sphinx conditional text directives.

• Create different documents from the same sources using Jinja

  Task

  Learning path: 6. Automation & legacy techniques›Jinja

  Profile reStructuredText content with Jinja and a Python preprocessing script to generate audience-specific document variants - user, admin, lite - from a single source.

• Create different documents from the same sources via Jinja (object method)

  Task

  Learning path: 6. Automation & legacy techniques›Jinja

  Profile content with Jinja by defining objects (audience, platform, version) to include or exclude blocks according to their attributes using a Python profiling script.

• The Raspberry Pi 3 as a documentation platform

  Task

  Learning path: 6. Automation & legacy techniques

  Set up a complete documentation platform on a Raspberry Pi 3: install Sphinx, generate PDF, HTML, and EPUB from reStructuredText, and manage content with Git.

← All topics