diff --git a/docs/releases/upcoming/237.doc.rst b/docs/releases/upcoming/237.doc.rst new file mode 100644 index 000000000..557595c8c --- /dev/null +++ b/docs/releases/upcoming/237.doc.rst @@ -0,0 +1 @@ +Document the ``apptools.io`` and ``apptools.io.h5`` sub packages (#237) \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 7524bf023..1891a5802 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,6 +10,7 @@ AppTools Documentation undo/* selection/* naming/* + io/* api * :ref:`search` diff --git a/docs/source/io/introduction.rst b/docs/source/io/introduction.rst new file mode 100644 index 000000000..6bdd04ef5 --- /dev/null +++ b/docs/source/io/introduction.rst @@ -0,0 +1,28 @@ +File I/O +======== + +The :mod:`apptools.io` package provides a traited |File| object provides +properties and methods for common file path manipulation operations. Much of +this functionality was implemented before Python 3 `pathlib`_ standard library +became available to provide similar support. For new code we encourage users +to investigate if `pathlib`_ can satisfy their use cases before they turn to +the `apptools.io` |File| object + +HDF5 File Support +----------------- + +The :mod:`apptools.io.h5` sub-package provides a wrapper around `PyTables`_ +with a dictionary-style mapping. + + +.. + external links + +.. _pathlib: https://docs.python.org/3/library/pathlib.html +.. _PyTables: https://www.pytables.org/ + + +.. + # substitutions + +.. |File| replace:: :class:`~apptools.io.file.File`