.. -*- coding: utf-8 -*-
.. :Project:   python-rapidjson -- Sphinx documentation
.. :Author:    Lele Gaifax <lele@metapensiero.it>
.. :License:   MIT License
.. :Copyright: © 2016, 2017, 2020, 2024 Lele Gaifax
..

===========================
 yggdrasil-python-rapidjson
===========================

-------------------------------------------
Python Wrapper around YggdrasilRapidJSON_
-------------------------------------------

This module implements a Python C-extension wrapper around YggdrasilRapidJSON_, which is an extension to RapidJSON_, an extremely fast
C++ JSON_ serialization library. This package was adapted from the `python-rapidjson <https://github.com/python-rapidjson/python-rapidjson>`_ package. This documentation serves to describe features added onto the python-rapidjson functionality. For information on the classes and methods implemented by python-rapidjson (which are included in yggdrasil-python-rapidjson), please refer to the `python-rapidjson documentation <https://python-rapidjson.readthedocs.io/en/latest/index.html>`_). All of the examples will be the same for yggdrasil-python-rapidjson, which the exception that the package is named ``yggdrasil_rapidjson`` instead of ``rapidjson``.

Contents:

.. toctree::
   :maxdepth: 2

   quickstart
   yggdrasil
   api
   changes

.. _YggdrasilRapidJSON: https://github.com/cropsinsilico/yggdrasil-rapidjson
.. _RapidJSON: http://rapidjson.org/
.. _JSON: https://www.json.org/


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

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