Austin
April 25-29, 2016

Event Details


A Problem: Single Sourcing with Sphinx

This session is a discussion of ways to resolve a problem with single sourcing using Sphinx. How would you single source your documentation without a content management system that most of the technical publishing world uses? What if your content lives in separate repositories? How can you apply conditions using Sphinx?

This use case will explain:

  • What is single sourcing in technical writing?
  • What are the possible workarounds to address the needs of TechPubs departments using Sphinx?
  • How to conditionalize the output
  • Other open-source documentation alternatives

Single sourcing is the concept of optimizing technical content reuse with multiple deliverables from a single source. Most OpenStack contributors use Sphinx and RST, so contributors are interested in leveraging all benefits of the tool. Configuring Sphinx so it addresses the needs of a Technical Publication department is crucial, so many OpenStack contributors will be interested in finding out about ways to better use Sphinx.


What can I expect to learn?
  • What is single sourcing in technical writing?
  • What are the possible workarounds to address the needs of TechPubs departments using Sphinx?
  • How to conditionalize the output
  • Other open-source documentation alternatives
Tuesday, April 26, 11:15am-11:55am
Difficulty Level: Beginner
Mirantis
Svetlana is an Information Architect at Mirantis. Recently, Svetlana was primarily focusing on creating an information architecture for Mirantis products. The main goal of Svetlana's work is to determine the unique language that Mirantis will use to communicate messages about its products through all channels, including documentation and software deliverables. FULL PROFILE