i207M / PINNacle-docs

Documentation for the PINNacle project

Docs for the PINNacle project

This is the documentation for the PINNacle project. It is built with Nextra.

Local Development

First, run npm install or pnpm i to install the dependencies.

Then, run npm run dev or pnpm dev to start the development server and visit localhost:3000.

API Documentation Auto-Generation

The API documentation is auto-generated from the source code using pdoc. To update the documentation, run pdoc --skip-errors --output=docs . under the PINNacle folder.

See the pdoc documentation for how to add docstrings to the source code.

License

This project is licensed under the MIT License.