# HG changeset patch # User Tero Koskinen # Date 1345666369 -10800 # Wed Aug 22 23:12:49 2012 +0300 # Node ID fd53267484ec683dcbf3566ea1a79345a759cf69 # Parent 099923d9c2f2e5c288e7478991c24966ee818c47 Use adadomain extension and add beginnings of API docs. diff --git a/doc/source/api-json.rst b/doc/source/api-json.rst new file mode 100644 --- /dev/null +++ b/doc/source/api-json.rst @@ -0,0 +1,34 @@ +:mod:`JSON` -- Package +======================= + +.. ada:module:: JSON +.. moduleauthor:: Tero Koskinen + +----- +Types +----- + +**JSON_Integer** + + subtype JSON_Integer is Multi_precision_integers.Multi_int; + +JSON_Integer is the type representing integer numbers in JSON data. + +If the number fits into Integer\'Range you can print the value +with following code: + +:: + + declare + Val : constant JSON.JSON_Integer := ...; + begin + Put_Line (Integer'Image (Multi_precision_integers.Basic (Val))); + end; + +**JSON_Float** + + subtype JSON_Float is Float; + +JSON_Float is the type representing float numbers in JSON data. + + diff --git a/doc/source/api.rst b/doc/source/api.rst new file mode 100644 --- /dev/null +++ b/doc/source/api.rst @@ -0,0 +1,8 @@ +------------------------------- +API Documentation for Jdaughter +------------------------------- + +.. toctree:: + :maxdepth: 2 + + api-json.rst diff --git a/doc/source/conf.py b/doc/source/conf.py --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -25,7 +25,7 @@ # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [] +extensions = ['sphinxcontrib.adadomain'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/doc/source/index.rst b/doc/source/index.rst --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -9,6 +9,7 @@ overview.rst install.rst + api.rst Indices and tables ==================