From f5453861f646873b1800e657faa9e4b8684c21ba Mon Sep 17 00:00:00 2001 From: Dirk Alders Date: Sun, 3 Jan 2021 21:04:15 +0100 Subject: [PATCH] Module documentation update --- __init__.py | 12 ++--- _docs_/index.html | 97 +++++++++++++++++++++-------------- _docs_/searchindex.js | 2 +- _examples_/Makefile | 11 ++++ _examples_/csp.build_frame.py | 9 ++++ _examples_/csp.csp.py | 12 +++++ _examples_/gzip_compress.py | 8 +++ _examples_/gzip_extract.py | 8 +++ _examples_/hexlify.py | 6 +++ _examples_/stp.build_frame.py | 6 +++ _examples_/stp.stp.py | 12 +++++ csp.py | 12 ++--- stp.py | 12 ++--- 13 files changed, 149 insertions(+), 58 deletions(-) create mode 100644 _examples_/Makefile create mode 100644 _examples_/csp.build_frame.py create mode 100644 _examples_/csp.csp.py create mode 100644 _examples_/gzip_compress.py create mode 100644 _examples_/gzip_extract.py create mode 100644 _examples_/hexlify.py create mode 100644 _examples_/stp.build_frame.py create mode 100644 _examples_/stp.stp.py diff --git a/__init__.py b/__init__.py index 49e8bbe..190d4eb 100644 --- a/__init__.py +++ b/__init__.py @@ -125,11 +125,11 @@ def gzip_compress(s, compresslevel=9): **Example:** - .. literalinclude:: ../examples/gzip_compress.py + .. literalinclude:: stringtools/_examples_/gzip_compress.py Will result to the following output: - .. literalinclude:: ../examples/gzip_compress.log + .. literalinclude:: stringtools/_examples_/gzip_compress.log """ rv = None t = time.time() @@ -159,11 +159,11 @@ def gzip_extract(s): **Example:** - .. literalinclude:: ../examples/gzip_extract.py + .. literalinclude:: stringtools/_examples_/gzip_extract.py Will result to the following output: - .. literalinclude:: ../examples/gzip_extract.log + .. literalinclude:: stringtools/_examples_/gzip_extract.log """ t = time.time() rv = None @@ -191,11 +191,11 @@ def hexlify(s): **Example:** - .. literalinclude:: ../examples/hexlify.py + .. literalinclude:: stringtools/_examples_/hexlify.py Will result to the following output: - .. literalinclude:: ../examples/hexlify.log + .. literalinclude:: stringtools/_examples_/hexlify.log """ rv = '(%d):' % len(s) for byte in s: diff --git a/_docs_/index.html b/_docs_/index.html index a1b8248..542a954 100644 --- a/_docs_/index.html +++ b/_docs_/index.html @@ -84,8 +84,8 @@