Writing multi-language documentation using Sphinx
summary
Shows a concrete Sphinx workflow: extract strings with sphinx-build -b gettext, produce PO/MO catalogs, use the sphinx-intl extension to automate make gettext and build per-language outputs, and push/pull translations with tx push and tx pull to Transifex (free for open source). Notes problems: builds overwrite the same target so languages must be built separately, no built-in language switch or landing page, and forthcoming Sphinx 1.3 aims to include sphinx-intl and a single-command multi-language build.
AI-written summary · about
chapters (14)
- 0:00Markus Zapke-Gründemann
- 3:06Internationalization
- 4:34gettext Example
- 6:10Workflow
- 7:48Configuration
- 10:09Sphinx il 8n Process
- 14:01Transifex Setup
- 15:05Transifex and sphinx-intl
- 17:21Using code inside the documentation
- 18:07How to handle URLS
- 21:48How to handle special cases
- 23:06Link checking
- 24:00What is still missing?
- 27:25Sphinx 1.3
related talks
02h 28mWriting Documentation with Sphinx and reStructuredText
02h 59mDocumenting your code from docstrings to automated builds
36mSphinx autodoc: automated API documentation
01h 06mDocument your code
22mStatic Sites with Sphinx and Markdown
29mSpanish Spoken Here
31mIncorporating Managed Information Repositories to Generate On-Demand Documentation
30mMaking Your Documentation Interactive with PyScript