diff --git a/docs/source/index.md b/docs/source/index.md index 2b985ee57b03c4e1c3c456da2259e017badda7ef..796ad82597de6d64596b5442a1ab1ef05f6414cb 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -6,6 +6,7 @@ pages/quick-start pages/protocol pages/client +pages/utils pages/development ``` diff --git a/docs/source/pages/development.md b/docs/source/pages/development.md index 68e293203289b4154f56a70f113eec21707b7f73..585c0a02518a28820b7f78d925485c1064c18d69 100644 --- a/docs/source/pages/development.md +++ b/docs/source/pages/development.md @@ -20,3 +20,9 @@ Generate errors ```bash python -m tools.codegen errors errors.json ``` + +## Running tests +To run tests, make sure that `pytest` is installed and simply run: +```bash +pytest +``` \ No newline at end of file diff --git a/docs/source/pages/protocol.md b/docs/source/pages/protocol.md index 79097037fbda6cee6d3b6ee42c056ee59366f53f..98ec3db877b30fe3c7b66156392fef11ab70a4f2 100644 --- a/docs/source/pages/protocol.md +++ b/docs/source/pages/protocol.md @@ -1,4 +1,5 @@ # Protocol +The protocol module subpackage implements LysKOM types as well as a parser and writer for encoding/decoding. ## Base ```{eval-rst} .. automodule:: pyskom.protocol.base diff --git a/docs/source/pages/utils.md b/docs/source/pages/utils.md new file mode 100644 index 0000000000000000000000000000000000000000..16ec7b8a5751febe8c82e5b6fa37bbe7fcb3ac4a --- /dev/null +++ b/docs/source/pages/utils.md @@ -0,0 +1,8 @@ +# Utils +## Text-no utils +```{eval-rst} +.. automodule:: pyskom.utils.text_no + :members: + :undoc-members: + +``` diff --git a/pyskom/utils/__init__.py b/pyskom/utils/__init__.py index a52ebf1d2c29556d71b674af0a888b8232b30c33..75254aea34eeab3f978a208e52569b306eb6f327 100644 --- a/pyskom/utils/__init__.py +++ b/pyskom/utils/__init__.py @@ -1 +1 @@ -from .text_no import read_to_unread \ No newline at end of file +from .text_no import read_to_unread, text_block_to_list \ No newline at end of file diff --git a/readme.md b/readme.md index 9410332f4c337b8f6d0796e25706181e496e28b9..2a544718b647f66f72d5aecf656342a3750d3d82 100644 --- a/readme.md +++ b/readme.md @@ -1,5 +1,5 @@ -# TODO -* Types - * Arrays - * ... -* Protocol A writer \ No newline at end of file +# PysKOM +Pyskom is a LysKOM library written in Python. + +## Documentation +[https://www.lysator.liu.se/~ivma/pyskom/docs/index.html](https://www.lysator.liu.se/~ivma/pyskom/docs/index.html) \ No newline at end of file