API Site

API Site is an installation profile that (nearly) automatically creates a documentation site for the Drupal API. This is similar to api.drupal.org.

Having an Drupal API site can very helpful to yourself and others. Running one locally means that you can always have a browsable reference to the Drupal API even without an internet connection. Running one that is public can be beneficial to the community if the Drupal API site goes down. It is also a good base to include contributed modules which are not on the main Drupal API site.

Installation

The suggested method of using this profile is with Drush Make, due to how distributions are currently created on drupal.org. This means you will have to be familiar with the command line.

1. Install Drush.
2. Install Drush Make.
3. Get the profile with Drush: drush dl apisite
4. Drush Make a new Drupal site: drush make apisite/apisite.make {your_new_directory_name}
5. Go into new site: cd {your_new_directory_name}
6. Get the profile (you could just copy it, but Drush is so easy): drush dl apisite
7. Install Drupal like you would normally. Choose the API Site profile.
8. Run cron a number of times (until there are no jobs left) so that all the API files can be indexed. Drupal path to run cron: admin/reports/status/run-cron. Drupal path to view jobs: admin/reports/job_queue.
9. Depending on your tastes, you may want to change the default Pixture color scheme from pink. Drupal path: admin/build/themes/settings/pixture

Using the Distribution

This installation profile currently does not utilize the new Distribution Packaging. This is due to the fact that the API files are treated like libraries (which are assumed to be third-party code).

Limitations and To-Do

• Current limitations of the drupal.org infrascture. The conversation about letting third-party code into the CVS repo is still happening. #594704: Allow packaged install profiles on d.o to pull in code from other sources + sites
• The last two steps of the installation described above should be automated. This is a lack of knowledge on my part and some annoyances with the installation process in Drupal.