DEV Community

loading...

What do you use to document your codebase and APIs?

mikeyarce profile image mikey arce ・1 min read

Where I work, we have a large assortment of APIs, helper classes, functions, and other things like hooks - all which we need to document for our customers.

I'm curious - if you have a similar problem, what do you use to document your code and APIs?

Discussion (1)

pic
Editor guide
Collapse
juancarlospaco profile image
Juan Carlos • Edited

Restructured-Text and Markdown mixed together,
that gets compiled to HTML/PDF documentation,
also runnableExamples that are code snippet examples that run as test and doc at the same time,
everything is done automatically by the compiler in Nim lang