API

The API module was designed to produce the Drupal developer documentation available at api.drupal.org. You can set up your own API documentation site by following these instructions.

The API module implements a subset of the Doxygen documentation generator specification, with some Drupal-specific additions. Standards for how to write Drupal documentation that this module can parse (and that conforms to Drupal coding standards) are on http://drupal.org/node/1354.

Versions

Note that whatever version of the API module you are running, you can set up an API site to display code/documentation from any Drupal version, so in some sense, the version of Drupal you are running your API site on doesn't matter too much.

Drupal 9/10

There is a Drupal 9/10 version ready to use. The architecture is similar to the D7 version. Simply enable the module, set up the projects and branches, and run cron and the parsing queue. Backend and Frontend navigation, links, elements should feel very similar to what was found in D7.

Drupal 7

The 7.x-2.x branch is the supported branch. There are instructions on upgrading from earlier versions, including Drupal 6 and the7.x-1.x branch, at the bottom of the installation instructions page. Please read them.

Also, whenever you update to a new release (or a new commit if you are using a development branch), be sure to read the release notes!

Maintainers

This project is currently under the active maintainership of drumm and fjgarlin.

We welcome your contributions via the issue queue (see sidebar). The issues in the issue queue are regularly updated so that our highest-priority bugs and feature requests are marked "major" or "critical", and the ones we aren't too interested in are marked "postponed", so please choose issues accordingly to have the biggest impact and best chance of success. The project README.txt file has some information about the architecture of the module, for developers new to the project.