creating an API documentation site in Drupal

Part of my job involves maintaining the REST API for a product called Bullseye. It’s an evolving API, and we’ve always kept the documentation in a Word file, which we simply print to PDF and publish to our web site. But, it seems kind of silly not to have a real on-line documentation site, so I started working on one recently. I’m using the book module in Drupal, along with CKEditor and GeSHi. Right now, I’m simply going through the Word doc, and pasting stuff into Drupal nodes using the “paste from Word” function in CKEditor. I’ve been pleasantly surprised at how well that works. The HTML that results usually looks pretty clean. For code samples, I just decorate them with the GeSHi tags and that does a pretty good job. I want to mess with the font settings in GeSHi a bit, but other than that, I like it.

At some point, I’m going to want to see how I can go in and hyperlink related classes and methods, and stuff like that. I’m hoping I can find a way to do that automatically, rather than having to go in and manually create a bunch of hyperlinks.

Leave a Reply