Treemo Labs API Documentation

Development

Treemo documentation screenshot

The Treemo documentation project’s purpose was to take Treemo Labs’ existing API documentation in PDF form and transform it into a searchable and more easily read online form. The documentation was to be able to be auto-generated on demand.

Employer

Treemo Labs

Involvement

  • Wrote a PHP script that parsed the API method’s comment blocks and converted them into ReST (ReStructured text) files to be ingested by Sphinx
  • Used Sphinx and the ‘ADCTheme’ to generate the API documenation

Technologies Used

PHP, Treemo API, Sphinx documentation generator