Skip to content
Olivier CarrèreTechnical writing practice

Python

Documentation pages on Python (7 pages).

This topic brings together 7 pages across the manual:

7 Tasks

  • Auto-insert data into a DITA XML file

    Task

    Learning path: 6. Automation & legacy techniquesPython

    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

    Task

    Learning path: 6. Automation & legacy techniquesJinja

    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 techniquesPython

    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 sources using Jinja

    Task

    Learning path: 6. Automation & legacy techniquesJinja

    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 techniquesJinja

    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

    Task

    Learning path: 6. Automation & legacy techniquesPython

    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.

  • 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