From 65eee8ca19391dcb4df172891972d4436e65de1b Mon Sep 17 00:00:00 2001 From: Chris Sewell Date: Fri, 11 Aug 2017 18:13:51 +0100 Subject: [PATCH] doc update of highlights --- docs/source/index.rst | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index a552c9d..8193e1f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -12,25 +12,27 @@ A module to extend the python json package functionality: - Treat a directory structure like a nested dictionary -- **Lightweight plugin system**: define bespoke classes for **parsing** +- **Lightweight plugin system**: define bespoke classes for parsing different file extensions (in-the-box: .json, .csv, .hdf5) and - **encoding/decoding** objects + encoding/decoding objects. - **Lazy Loading**: read files only when they are indexed into - **Tab Completion**: index as tabs for quick exploration of data -- Manipulation of nested structures, including; filter, merge, flatten, unflatten +- **Manipulation of nested structures**, including; filter, merge, flatten, unflatten -- Enhanced pretty printer +- **Enhanced pretty printer** -- Output to directory structure (of n folder levels) +- **Output to directory structure** (of n folder levels) -- On-disk indexing option for large json files (using the ijson +- **On-disk indexing** option for large json files (using the ijson package) -- Units schema concept to apply and convert physical quantities (using the +- **Units schema** concept to apply and convert physical quantities (using the pint package) + +- All functions are thoroughly documented with tested examples. .. toctree:: :maxdepth: 2