.. Pingwyn documentation master file, created by
   sphinx-quickstart on Mon Mar 23 11:49:04 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Pingwyn documentation
=====================

This is the documentation for Pingwyn, PIN's in-house toolkit for SPM analysis. Currently, this
documentation is generated automatically based on the docstrings found in the source of Pingwyn. As
such, this documentation is meant as a quick reference for funcions and object types, and how to
implement them in your own scripts.

.. toctree::
   :maxdepth: 2

   reference/types
   reference/file-handling
   reference/manipulation
   reference/plotting
   Full reference <_autosummary/global/pingwyn>

.. autosummary::
	:toctree: ./_autosummary/global
   :template: template-module-auto-reference.rst
	:recursive:

	pingwyn