Services#

Bootsrap your Documentation#

Get your documentation website up and running in 1 month. Whether you’re just starting out or have a collection of readmes, comments, and e-mailed documents that need wrangling, we can create order out of chaos and have proven workflows to get your team contributing and maintaining the docs quickly.

We avoid lock-in by starting with off the shelf, open source software that is easy to use and maintain. As your needs evolve, we have the know-how to customize and grow your site.

Verify your Documentation#

Nothing is more frustrating than out of date or incorrect docs. I am an experienced engineer with lots of validation experience. I can review your documentation, identify new user pain points, and work with engineering to update the documentation.

Custom Directives, Roles, and Extensions#

When the need arises (which isn’t as often as you might think) we can create custom plug-ins for Sphinx or other tools that we use.

For example, sphinx-md is a Sphinx extension we created specifically to turn existing Markdown documentation in a GitHub repository into a working Sphinx project within minimal impact to existing doc structure.

Theme layout and appearance#

Base your docs on the “Read the Docs” or other theme to get started. If that doesn’t meet your needs and we can tweak it to get it just the way you like.

API documentation integration#

Integrating Python docstrings into Sphinx is trivial (that’s what is was made for), but it is also possible to integrate Doxygen based content into Sphinx. Here are a couple of projects that we helped:

  1. OneDNN

  2. OpenVINO

Custom Output Targets#

Some projects need to be published to multiple formats. Sphixn supports publishing to html natively, but with a little work it can publish to docx and pdf as well. Beyond that we have experience converting Sphinx based projects to the Darwin Information Typing Architecture (DITA) using a custom extension as well.

Internationalization Support#

Sphinx has built-in support for .po files, including tracking out-of-date files. We can help you get started.

Automated build and deployment#

CI/CD saves time and improves quality. We can make sure your docs are up to date by automating deployment from GitHub or integrate into your exisitng automation framework.