From 825dc2eca5d7143d366d7027e3d867557de6e6b3 Mon Sep 17 00:00:00 2001 From: Barnaby Shearer Date: Sun, 14 Nov 2021 21:39:06 +0000 Subject: [PATCH] initial docs --- docs/index.rst | 18 ++++++++++++++++++ docs/install.rst | 8 ++++++++ docs/pynfc.rst | 5 +++++ 3 files changed, 31 insertions(+) create mode 100644 docs/index.rst create mode 100644 docs/install.rst create mode 100644 docs/pynfc.rst diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..51c4545 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,18 @@ +pynfc +===== + +`ctypeslib` converted libnfc and libfreefare. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + install + pynfc + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/install.rst b/docs/install.rst new file mode 100644 index 0000000..07966c7 --- /dev/null +++ b/docs/install.rst @@ -0,0 +1,8 @@ +Installation +============ + +:: + + sudo apt install libfreefare-dev + pip install pynfc + diff --git a/docs/pynfc.rst b/docs/pynfc.rst new file mode 100644 index 0000000..1a28059 --- /dev/null +++ b/docs/pynfc.rst @@ -0,0 +1,5 @@ +pynfc +===== + +.. automodule:: pynfc + :members: