Technical Documentation

Let me help you streamline your documentation publishing workflow. We’ll figure out how to get from where you are to where you want to be whether you just need training or full technical support. I specialize in Sphinx-based projects.

contact: docs@slynconsulting.com

Training

Get your team up and running using Sphinx to publish and deploy your docs.

Topics include:

• Documentation as code

• Installation and getting started

• Setting up your conf.py

• Optimize your project file hierarchy

• Basics of authoring in reStructuredText and Markdown

• Docutils vs Sphinx

• Sphinx directives and roles

• Basic GitHub best practices

Services

I offer support for Sphinx-based documentation projects including:

• Documentation bootstrap from scratch or with existing documentation

• Custom Directives/Roles/Extensions

• Customization of layout and appearance

• API documentation integration including Doxygen

• Source conversion to Open Source friendly formats

• Custom output targets

• Support for Internationalization

• Automated build and deployment

I can help your team avoid uneccessary code maintenance and technical debt.

• Training
• Services
  • Bootsrap your Documentation
  • Verify your Documentation
  • Custom Directives, Roles, and Extensions
  • Theme layout and appearance
  • API documentation integration
  • Custom Output Targets
  • Internationalization Support
  • Automated build and deployment