From b073b06e0356efed6f8f15f7b112c33c967607e7 Mon Sep 17 00:00:00 2001 From: Agie Ashwood Date: Fri, 2 Aug 2024 04:27:56 +0000 Subject: [PATCH] Docs: Title fixing rst --- docs/Cryptography/WhaleSong.md | 6 +- docs/Daisy/Catch.md | 10 +-- docs/Daisy/Daisy.md | 6 +- docs/Daisy/Soil.md | 4 +- docs/Daisy/Store.md | 6 +- docs/Packets/Packet.md | 4 +- docs/Packets/SinglePacket.md | 6 +- docs/Packets/SubMessage.md | 6 +- docs/Packets/SubPacket.md | 6 +- docs/Siph/map.md | 4 +- docs/Sponge/base.md | 10 ++- docs/Transceiver/Transceiver.md | 4 +- docs/readme.md | 113 +++++++++++++++++--------------- src/Cryptography/WhaleSong.rst | 5 +- src/Daisy/Cache.rst | 2 +- src/Daisy/Catch.rst | 6 +- src/Daisy/Daisy.rst | 5 +- src/Daisy/Soil.rst | 4 +- src/Daisy/Store.rst | 5 +- src/Packets/Packet.rst | 4 +- src/Packets/SinglePacket.rst | 5 +- src/Packets/SubMessage.rst | 5 +- src/Packets/SubPacket.rst | 5 +- src/Siph/map.rst | 4 +- src/Sponge/base.rst | 8 ++- src/Transceiver/Transceiver.rst | 4 +- 26 files changed, 124 insertions(+), 123 deletions(-) diff --git a/docs/Cryptography/WhaleSong.md b/docs/Cryptography/WhaleSong.md index 18893ee2..76d59ed2 100644 --- a/docs/Cryptography/WhaleSong.md +++ b/docs/Cryptography/WhaleSong.md @@ -1,6 +1,6 @@ -Diffie hellman ephemeral -Fernet based encryption -========================== + + +# WhaleSong: Diffie hellman ephemeral Fernet based encryption ### *class* Cryptography.WhaleSong.DHEFern(cache, nodeNickname, cLog) diff --git a/docs/Daisy/Catch.md b/docs/Daisy/Catch.md index dcbf4905..60c30511 100644 --- a/docs/Daisy/Catch.md +++ b/docs/Daisy/Catch.md @@ -1,6 +1,6 @@ -Daisy cache for catchs, -PierMesh’s domain analog -========================== + + +# Daisy Catch cache ### *class* Daisy.Catch.Catch(path: str = 'catch', filepaths=None, catchFile=None, walk: bool = False) @@ -10,10 +10,6 @@ Sub class of Cache for handling catchs [🔗 Source](https://git.utopic.work/PierMesh/piermesh/src/branch/main/Daisy/Catch.py) -#### addc(peer, node, seperator, head, tail, data, fins=None) - -#### catches *= {}* - #### get(head: str, tail: str, fins=None) Get catch by pieces diff --git a/docs/Daisy/Daisy.md b/docs/Daisy/Daisy.md index f4fae3db..8fa072f4 100644 --- a/docs/Daisy/Daisy.md +++ b/docs/Daisy/Daisy.md @@ -1,8 +1,8 @@ ![Daisy logo](https://git.utopic.work/PierMesh/piermesh/raw/branch/main/imgs/daisydisplay.png) -Schemaless binary database -base class -========================== + + +# Daisy ### *class* Daisy.Daisy.Daisy(filepath: str, templates: dict = {}, template: bool = False, prefillDict: bool = False) diff --git a/docs/Daisy/Soil.md b/docs/Daisy/Soil.md index bbc6fb69..86ec6868 100644 --- a/docs/Daisy/Soil.md +++ b/docs/Daisy/Soil.md @@ -1,6 +1,6 @@ - + -# Daisy signal management +# Soil: Daisy signal management ### *class* Daisy.Soil.Compound(cache, isCatch: bool = False) diff --git a/docs/Daisy/Store.md b/docs/Daisy/Store.md index 43dd0ba1..53610431 100644 --- a/docs/Daisy/Store.md +++ b/docs/Daisy/Store.md @@ -1,6 +1,6 @@ -Daisy based key value -store with recursion -========================== + + +# Store: Daisy key value store ### *class* Daisy.Store.Store(store: str, path: str, nodeNickname: str) diff --git a/docs/Packets/Packet.md b/docs/Packets/Packet.md index 82424c15..c8f37aa9 100644 --- a/docs/Packets/Packet.md +++ b/docs/Packets/Packet.md @@ -1,6 +1,6 @@ - + -# Base packet +# Packet: Base packet ### *class* Packets.Packet.Packet(data: bytes, packetsID: int = -1, packetNumber=False, packetCount: int = 1, packetsClass: int = -1) diff --git a/docs/Packets/SinglePacket.md b/docs/Packets/SinglePacket.md index d209ec08..36827190 100644 --- a/docs/Packets/SinglePacket.md +++ b/docs/Packets/SinglePacket.md @@ -1,6 +1,6 @@ -SinglePacket: Singular packet -for very low data applications -=============================== + + +# SinglePacket: Singular packet messages for very low data applications ### *class* Packets.SinglePacket.SinglePacket(data, packetsID, packetsClass=None, cache=None) diff --git a/docs/Packets/SubMessage.md b/docs/Packets/SubMessage.md index 370f56ce..10176c07 100644 --- a/docs/Packets/SubMessage.md +++ b/docs/Packets/SubMessage.md @@ -1,6 +1,6 @@ -SubPackets for handling -full submessages -======================= + + +# SubMessage: Additional data for larger messages ### *class* Packets.SubMessage.SubMessage diff --git a/docs/Packets/SubPacket.md b/docs/Packets/SubPacket.md index 3fcba041..958298a5 100644 --- a/docs/Packets/SubPacket.md +++ b/docs/Packets/SubPacket.md @@ -1,6 +1,6 @@ -SubPacket for handling -individual packets of submessages -================================= + + +# SubPacket: Packets for submessages ### *class* Packets.SubPacket.SubPacket diff --git a/docs/Siph/map.md b/docs/Siph/map.md index a98fb68d..0cadab23 100644 --- a/docs/Siph/map.md +++ b/docs/Siph/map.md @@ -1,6 +1,6 @@ - + -# Network map representation +# Network: Network map representation ### *class* Siph.map.Network(file=None) diff --git a/docs/Sponge/base.md b/docs/Sponge/base.md index 001e9a30..cbe96fc5 100644 --- a/docs/Sponge/base.md +++ b/docs/Sponge/base.md @@ -1,6 +1,6 @@ -Primary filtering functionality -Dispatches to Protocols -=============================== + + +# base: Primary filtering functionality ### *class* Sponge.base.Filter(cache, onodeID, todo, cLog) @@ -47,6 +47,10 @@ Check if this is a self packet, if so skip Base filtering logic, takes a single MeshTastic packet + + +# Protocols + #### *async* bubble.filter(recipient, recipientNode, onodeID, todo) Peer to peer protol diff --git a/docs/Transceiver/Transceiver.md b/docs/Transceiver/Transceiver.md index 46cf557e..4e06d37f 100644 --- a/docs/Transceiver/Transceiver.md +++ b/docs/Transceiver/Transceiver.md @@ -1,6 +1,6 @@ - + -# Layer 0 data transceiving +# Transceiver: Layer 0 data transceiving ### *class* Transceiver.Transceiver.Transceiver(device, filter, onodeID, cache, catch, cryptographyInfo, cLog) diff --git a/docs/readme.md b/docs/readme.md index 37baf3a4..8eb2afb8 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -43,7 +43,7 @@ sphinx-quickstart on Fri Jul 26 23:30:55 2024. --> * [`TUI.do_set_mem()`](/PierMesh/piermesh/src/branch/main/docs/ui.md#ui.TUI.do_set_mem) * [`TUI.do_write_line()`](/PierMesh/piermesh/src/branch/main/docs/ui.md#ui.TUI.do_write_line) * [`TUI.on_mount()`](/PierMesh/piermesh/src/branch/main/docs/ui.md#ui.TUI.on_mount) -* [Network map representation](/PierMesh/piermesh/src/branch/main/docs/Siph/map.md) +* [Network: Network map representation](/PierMesh/piermesh/src/branch/main/docs/Siph/map.md) * [`Network`](/PierMesh/piermesh/src/branch/main/docs/Siph/map.md#Siph.map.Network) * [`Network.omap`](/PierMesh/piermesh/src/branch/main/docs/Siph/map.md#Siph.map.Network.omap) * [`Network.imap`](/PierMesh/piermesh/src/branch/main/docs/Siph/map.md#Siph.map.Network.imap) @@ -69,55 +69,59 @@ sphinx-quickstart on Fri Jul 26 23:30:55 2024. --> * [`Cache.get()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Cache.md#Daisy.Cache.Cache.get) * [`Cache.refresh()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Cache.md#Daisy.Cache.Cache.refresh) * [`Cache.search()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Cache.md#Daisy.Cache.Cache.search) -* [`Catch`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Catch.md) - * [`Catch.addc()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Catch.md#Daisy.Catch.Catch.addc) - * [`Catch.catches`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Catch.md#Daisy.Catch.Catch.catches) - * [`Catch.get()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Catch.md#Daisy.Catch.Catch.get) - * [`Catch.sget()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Catch.md#Daisy.Catch.Catch.sget) -* [`Daisy`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md) - * [`Daisy.filepath`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md#Daisy.Daisy.Daisy.filepath) - * [`Daisy.msg`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md#Daisy.Daisy.Daisy.msg) - * [`Daisy.get()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md#Daisy.Daisy.Daisy.get) - * [`Daisy.read()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md#Daisy.Daisy.Daisy.read) - * [`Daisy.sublist()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md#Daisy.Daisy.Daisy.sublist) - * [`Daisy.write()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md#Daisy.Daisy.Daisy.write) -* [Daisy signal management](/PierMesh/piermesh/src/branch/main/docs/Daisy/Soil.md) +* [Daisy Catch cache](/PierMesh/piermesh/src/branch/main/docs/Daisy/Catch.md) + * [`Catch`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Catch.md#Daisy.Catch.Catch) + * [`Catch.get()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Catch.md#Daisy.Catch.Catch.get) + * [`Catch.sget()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Catch.md#Daisy.Catch.Catch.sget) +* [Daisy](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md) + * [`Daisy`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md#Daisy.Daisy.Daisy) + * [`Daisy.filepath`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md#Daisy.Daisy.Daisy.filepath) + * [`Daisy.msg`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md#Daisy.Daisy.Daisy.msg) + * [`Daisy.get()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md#Daisy.Daisy.Daisy.get) + * [`Daisy.read()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md#Daisy.Daisy.Daisy.read) + * [`Daisy.sublist()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md#Daisy.Daisy.Daisy.sublist) + * [`Daisy.write()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md#Daisy.Daisy.Daisy.write) +* [Soil: Daisy signal management](/PierMesh/piermesh/src/branch/main/docs/Daisy/Soil.md) * [`Compound`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Soil.md#Daisy.Soil.Compound) * [`Compound.on_any_event()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Soil.md#Daisy.Soil.Compound.on_any_event) -* [`Store`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Store.md) - * [`Store.getRecord()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Store.md#Daisy.Store.Store.getRecord) - * [`Store.update()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Store.md#Daisy.Store.Store.update) -* [`DHEFern`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md) - * [`DHEFern.cLog`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.cLog) - * [`DHEFern.loadedParams`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.loadedParams) - * [`DHEFern.loadedKeys`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.loadedKeys) - * [`DHEFern.nodeNickname`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.nodeNickname) - * [`DHEFern.cache`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.cache) - * [`DHEFern.publicKey`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.publicKey) - * [`DHEFern.privateKey`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.privateKey) - * [`DHEFern.checkInMem()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.checkInMem) - * [`DHEFern.decrypt()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.decrypt) - * [`DHEFern.encrypt()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.encrypt) - * [`DHEFern.genKeyPair()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.genKeyPair) - * [`DHEFern.genParams()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.genParams) - * [`DHEFern.getParamsBytes()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.getParamsBytes) - * [`DHEFern.getRecord()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.getRecord) - * [`DHEFern.getSalt()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.getSalt) - * [`DHEFern.initStore()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.initStore) - * [`DHEFern.keyDerive()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.keyDerive) - * [`DHEFern.loadParamBytes()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.loadParamBytes) - * [`DHEFern.loadRecordToMem()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.loadRecordToMem) -* [`Filter`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md) - * [`Filter.cache`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.base.Filter.cache) - * [`Filter.mCheck()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.base.Filter.mCheck) - * [`Filter.protoMap()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.base.Filter.protoMap) - * [`Filter.protoRoute()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.base.Filter.protoRoute) - * [`Filter.selfCheck()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.base.Filter.selfCheck) - * [`Filter.sieve()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.base.Filter.sieve) -* [`bubble.filter()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.Protocols.bubble.filter) -* [`catch.filter()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.Protocols.catch.filter) -* [`cryptography.filter()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.Protocols.cryptography.filter) -* [`map.filter()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.Protocols.map.filter) +* [Store: Daisy key value store](/PierMesh/piermesh/src/branch/main/docs/Daisy/Store.md) + * [`Store`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Store.md#Daisy.Store.Store) + * [`Store.getRecord()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Store.md#Daisy.Store.Store.getRecord) + * [`Store.update()`](/PierMesh/piermesh/src/branch/main/docs/Daisy/Store.md#Daisy.Store.Store.update) +* [WhaleSong: Diffie hellman ephemeral Fernet based encryption](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md) + * [`DHEFern`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern) + * [`DHEFern.cLog`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.cLog) + * [`DHEFern.loadedParams`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.loadedParams) + * [`DHEFern.loadedKeys`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.loadedKeys) + * [`DHEFern.nodeNickname`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.nodeNickname) + * [`DHEFern.cache`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.cache) + * [`DHEFern.publicKey`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.publicKey) + * [`DHEFern.privateKey`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.privateKey) + * [`DHEFern.checkInMem()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.checkInMem) + * [`DHEFern.decrypt()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.decrypt) + * [`DHEFern.encrypt()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.encrypt) + * [`DHEFern.genKeyPair()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.genKeyPair) + * [`DHEFern.genParams()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.genParams) + * [`DHEFern.getParamsBytes()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.getParamsBytes) + * [`DHEFern.getRecord()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.getRecord) + * [`DHEFern.getSalt()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.getSalt) + * [`DHEFern.initStore()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.initStore) + * [`DHEFern.keyDerive()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.keyDerive) + * [`DHEFern.loadParamBytes()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.loadParamBytes) + * [`DHEFern.loadRecordToMem()`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md#Cryptography.WhaleSong.DHEFern.loadRecordToMem) +* [base: Primary filtering functionality](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md) + * [`Filter`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.base.Filter) + * [`Filter.cache`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.base.Filter.cache) + * [`Filter.mCheck()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.base.Filter.mCheck) + * [`Filter.protoMap()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.base.Filter.protoMap) + * [`Filter.protoRoute()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.base.Filter.protoRoute) + * [`Filter.selfCheck()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.base.Filter.selfCheck) + * [`Filter.sieve()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.base.Filter.sieve) +* [Protocols](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#protocols) + * [`bubble.filter()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.Protocols.bubble.filter) + * [`catch.filter()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.Protocols.catch.filter) + * [`cryptography.filter()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.Protocols.cryptography.filter) + * [`map.filter()`](/PierMesh/piermesh/src/branch/main/docs/Sponge/base.md#Sponge.Protocols.map.filter) * [Header packet: Metadata packet](/PierMesh/piermesh/src/branch/main/docs/Packets/HeaderPacket.md) * [`Header`](/PierMesh/piermesh/src/branch/main/docs/Packets/HeaderPacket.md#Packets.HeaderPacket.Header) * [`Header.sender`](/PierMesh/piermesh/src/branch/main/docs/Packets/HeaderPacket.md#Packets.HeaderPacket.Header.sender) @@ -129,7 +133,7 @@ sphinx-quickstart on Fri Jul 26 23:30:55 2024. --> * [`Header.pAction`](/PierMesh/piermesh/src/branch/main/docs/Packets/HeaderPacket.md#Packets.HeaderPacket.Header.pAction) * [`Header.dump()`](/PierMesh/piermesh/src/branch/main/docs/Packets/HeaderPacket.md#Packets.HeaderPacket.Header.dump) * [`Header.usePreset()`](/PierMesh/piermesh/src/branch/main/docs/Packets/HeaderPacket.md#Packets.HeaderPacket.Header.usePreset) -* [Base packet](/PierMesh/piermesh/src/branch/main/docs/Packets/Packet.md) +* [Packet: Base packet](/PierMesh/piermesh/src/branch/main/docs/Packets/Packet.md) * [`Packet`](/PierMesh/piermesh/src/branch/main/docs/Packets/Packet.md#Packets.Packet.Packet) * [`Packet.data`](/PierMesh/piermesh/src/branch/main/docs/Packets/Packet.md#Packets.Packet.Packet.data) * [`Packet.packetsID`](/PierMesh/piermesh/src/branch/main/docs/Packets/Packet.md#Packets.Packet.Packet.packetsID) @@ -138,10 +142,13 @@ sphinx-quickstart on Fri Jul 26 23:30:55 2024. --> * [`Packet.packetsClass`](/PierMesh/piermesh/src/branch/main/docs/Packets/Packet.md#Packets.Packet.Packet.packetsClass) * [`Packet.dump()`](/PierMesh/piermesh/src/branch/main/docs/Packets/Packet.md#Packets.Packet.Packet.dump) * [`Packet.parsePayload()`](/PierMesh/piermesh/src/branch/main/docs/Packets/Packet.md#Packets.Packet.Packet.parsePayload) -* [`SinglePacket`](/PierMesh/piermesh/src/branch/main/docs/Packets/SinglePacket.md) -* [`SubMessage`](/PierMesh/piermesh/src/branch/main/docs/Packets/SubMessage.md) -* [`SubPacket`](/PierMesh/piermesh/src/branch/main/docs/Packets/SubPacket.md) -* [Layer 0 data transceiving](/PierMesh/piermesh/src/branch/main/docs/Transceiver/Transceiver.md) +* [SinglePacket: Singular packet messages for very low data applications](/PierMesh/piermesh/src/branch/main/docs/Packets/SinglePacket.md) + * [`SinglePacket`](/PierMesh/piermesh/src/branch/main/docs/Packets/SinglePacket.md#Packets.SinglePacket.SinglePacket) +* [SubMessage: Additional data for larger messages](/PierMesh/piermesh/src/branch/main/docs/Packets/SubMessage.md) + * [`SubMessage`](/PierMesh/piermesh/src/branch/main/docs/Packets/SubMessage.md#Packets.SubMessage.SubMessage) +* [SubPacket: Packets for submessages](/PierMesh/piermesh/src/branch/main/docs/Packets/SubPacket.md) + * [`SubPacket`](/PierMesh/piermesh/src/branch/main/docs/Packets/SubPacket.md#Packets.SubPacket.SubPacket) +* [Transceiver: Layer 0 data transceiving](/PierMesh/piermesh/src/branch/main/docs/Transceiver/Transceiver.md) * [`Transceiver`](/PierMesh/piermesh/src/branch/main/docs/Transceiver/Transceiver.md#Transceiver.Transceiver.Transceiver) * [`Transceiver.cLog`](/PierMesh/piermesh/src/branch/main/docs/Transceiver/Transceiver.md#Transceiver.Transceiver.Transceiver.cLog) * [`Transceiver.cryptographyInfo`](/PierMesh/piermesh/src/branch/main/docs/Transceiver/Transceiver.md#Transceiver.Transceiver.Transceiver.cryptographyInfo) diff --git a/src/Cryptography/WhaleSong.rst b/src/Cryptography/WhaleSong.rst index 3014393a..cd10fad5 100644 --- a/src/Cryptography/WhaleSong.rst +++ b/src/Cryptography/WhaleSong.rst @@ -1,7 +1,6 @@ -Diffie hellman ephemeral -Fernet based encryption -========================== +WhaleSong: Diffie hellman ephemeral Fernet based encryption +=========================================================== .. autoclass:: Cryptography.WhaleSong.DHEFern :members: diff --git a/src/Daisy/Cache.rst b/src/Daisy/Cache.rst index 44dd246e..671a13c1 100644 --- a/src/Daisy/Cache.rst +++ b/src/Daisy/Cache.rst @@ -1,5 +1,5 @@ Daisy based cache -========================== +================= .. autoclass:: Daisy.Cache.Cache :members: diff --git a/src/Daisy/Catch.rst b/src/Daisy/Catch.rst index 9b07f2b1..39c3fc66 100644 --- a/src/Daisy/Catch.rst +++ b/src/Daisy/Catch.rst @@ -1,7 +1,5 @@ -Daisy cache for catchs, -PierMesh's domain analog -========================== +Daisy Catch cache +================= .. autoclass:: Daisy.Catch.Catch :members: - :undoc-members: diff --git a/src/Daisy/Daisy.rst b/src/Daisy/Daisy.rst index 119cacf8..d035afe9 100644 --- a/src/Daisy/Daisy.rst +++ b/src/Daisy/Daisy.rst @@ -1,6 +1,5 @@ -Schemaless binary database -base class -========================== +Daisy +===== .. autoclass:: Daisy.Daisy.Daisy :members: diff --git a/src/Daisy/Soil.rst b/src/Daisy/Soil.rst index c6ac8634..7005bebc 100644 --- a/src/Daisy/Soil.rst +++ b/src/Daisy/Soil.rst @@ -1,5 +1,5 @@ -Daisy signal management -========================== +Soil: Daisy signal management +============================= .. autoclass:: Daisy.Soil.Compound :members: diff --git a/src/Daisy/Store.rst b/src/Daisy/Store.rst index 5dbc22fa..6e423d87 100644 --- a/src/Daisy/Store.rst +++ b/src/Daisy/Store.rst @@ -1,6 +1,5 @@ -Daisy based key value -store with recursion -========================== +Store: Daisy key value store +============================ .. autoclass:: Daisy.Store.Store :members: diff --git a/src/Packets/Packet.rst b/src/Packets/Packet.rst index c47ca656..8277f681 100644 --- a/src/Packets/Packet.rst +++ b/src/Packets/Packet.rst @@ -1,5 +1,5 @@ -Base packet -=============================== +Packet: Base packet +=================== .. autoclass:: Packets.Packet.Packet :members: diff --git a/src/Packets/SinglePacket.rst b/src/Packets/SinglePacket.rst index 9a833081..8a827abe 100644 --- a/src/Packets/SinglePacket.rst +++ b/src/Packets/SinglePacket.rst @@ -1,6 +1,5 @@ -SinglePacket: Singular packet -for very low data applications -=============================== +SinglePacket: Singular packet messages for very low data applications +===================================================================== .. autoclass:: Packets.SinglePacket.SinglePacket :members: diff --git a/src/Packets/SubMessage.rst b/src/Packets/SubMessage.rst index 6ea82643..d83958ef 100644 --- a/src/Packets/SubMessage.rst +++ b/src/Packets/SubMessage.rst @@ -1,6 +1,5 @@ -SubPackets for handling -full submessages -======================= +SubMessage: Additional data for larger messages +=============================================== .. autoclass:: Packets.SubMessage.SubMessage :members: diff --git a/src/Packets/SubPacket.rst b/src/Packets/SubPacket.rst index cccb518f..1eb6f265 100644 --- a/src/Packets/SubPacket.rst +++ b/src/Packets/SubPacket.rst @@ -1,6 +1,5 @@ -SubPacket for handling -individual packets of submessages -================================= +SubPacket: Packets for submessages +================================== .. autoclass:: Packets.SubPacket.SubPacket :members: diff --git a/src/Siph/map.rst b/src/Siph/map.rst index 433da5eb..43fba7b1 100644 --- a/src/Siph/map.rst +++ b/src/Siph/map.rst @@ -1,5 +1,5 @@ -Network map representation -========================== +Network: Network map representation +=================================== .. autoclass:: Siph.map.Network :members: diff --git a/src/Sponge/base.rst b/src/Sponge/base.rst index c305148c..b75ca237 100644 --- a/src/Sponge/base.rst +++ b/src/Sponge/base.rst @@ -1,11 +1,13 @@ -Primary filtering functionality -Dispatches to Protocols -=============================== +base: Primary filtering functionality +===================================== .. autoclass:: Sponge.base.Filter :members: :undoc-members: +Protocols +========= + .. automethod:: Sponge.Protocols.bubble.filter .. automethod:: Sponge.Protocols.catch.filter diff --git a/src/Transceiver/Transceiver.rst b/src/Transceiver/Transceiver.rst index 59b6db6f..9e8589b2 100644 --- a/src/Transceiver/Transceiver.rst +++ b/src/Transceiver/Transceiver.rst @@ -1,5 +1,5 @@ -Layer 0 data transceiving -=============================== +Transceiver: Layer 0 data transceiving +====================================== .. autoclass:: Transceiver.Transceiver.Transceiver :members: