.. NLPGuard documentation master file, created by
   sphinx-quickstart on Fri Jan 24 23:24:44 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to NLPGuard's documentation!
=======================================

NLPGuard is a powerful library for annotating and identifying protected attributes in text data. This documentation provides an overview of its capabilities, installation instructions, examples, and detailed descriptions of its components.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started:

   introduction
   citation
   installation

.. toctree::
   :maxdepth: 2
   :caption: NLPGuard:

   nlpguard/nlpguard

.. toctree::
   :maxdepth: 2
   :caption: Tutorials and Examples:

   examples

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`