Automation

• Auto-insert data into a DITA XML file

  Automate DITA XML file generation with Python: dynamically insert product data into DITA topics to industrialize technical documentation.

• Automatically insert data into a reStructuredText file

  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

  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)

  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

  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)

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

• Regular expressions in Python

  Use Python's re library to search, extract, and transform text in documentation files - a practical regex guide for technical writers working with automation scripts.

• sed: modify your text without opening your files

  Learn to use sed, the Unix stream editor, to batch-edit technical documentation files without opening them - perfect for automating repetitive content updates.

• The Raspberry Pi 3 as a documentation platform

  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