.. k3fs documentation master file, created by
   sphinx-quickstart on Thu May 14 16:58:55 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

k3fs
==========

pykit3 is is a collection of toolkit in python3.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

.. contents::
   :depth: 4
   :local:

Documentation for the Code
**************************

.. automodule:: k3fs


.. Exceptions
.. ----------

.. .. autoexception::  CalledProcessError
.. .. autoexception::  ProcError
.. .. autoexception::  TimeoutExpired


Functions
---------

.. autofunction::  ls_dirs
.. autofunction::  ls_files
.. autofunction::  makedirs
.. autofunction::  fread
.. autofunction::  fwrite
.. autofunction::  remove

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

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