Cooking documentation in Sphinx: recipes and my experience
-
-
40 min
The presentation is a cookbook in which I will share recipes for implementing Sphinx. Sphinx is a documentation generator that converts text written in reStructuredText and Markdown markup languages into various formats: HTML, PDF, DOCX and others.
Sphinx has become the main tool for technical writers in our company. The implementation of Sphinx allowed us to simultaneously utilize the advantages of the Docs-As-Code concept and powerful features so familiar to me from my work with Help&Manual.
In my presentation I will tell you:
- What kind of documentation we wanted to produce: how Sphinx closed our requirements for output documentation formats.
- What problems we encountered: we needed single source support and localization. Our product has Cloud and Enterprise versions, which differ in their functionality, as well as an interface in Russian and English.
- How we ended up producing useful documentation: process changes in the development team and the final results of the work.