Skip to content

API Docs

Online API Documentation

The full API documentation for the ACME CSE is available online at https://api.acmecse.net.

Generating API Documentation

Installing Pydoctor

Before running the commands, make sure to install the pydoctor package, which is required to generate the API documentation. You can install it by running:

Installing API Documentation Dependencies
pip install pydoctor

Generating API Documentation

You can generate the API documentation locally by running the following commands from the tools/apidocs directory of the ACME CSE distribution:

Generating API Documentation
make        # Generate API documentation
make open   # Open API documentation in the default web browser

The generated API documentation will be saved in the docs/apidocs directory of the ACME CSE distribution. You can open the generated API documentation by running make open or by opening the index.html file in the docs/apidocs directory in your web browser.