Docs: Title fixing rst

This commit is contained in:
Agie Ashwood 2024-08-02 04:27:56 +00:00
parent 7429930d06
commit b073b06e03
26 changed files with 124 additions and 123 deletions

View File

@ -1,6 +1,6 @@
Diffie hellman ephemeral
Fernet based encryption
==========================
<a id="whalesong-diffie-hellman-ephemeral-fernet-based-encryption"></a>
# WhaleSong: Diffie hellman ephemeral Fernet based encryption
### *class* Cryptography.WhaleSong.DHEFern(cache, nodeNickname, cLog)

View File

@ -1,6 +1,6 @@
Daisy cache for catchs,
PierMeshs domain analog
==========================
<a id="daisy-catch-cache"></a>
# 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

View File

@ -1,8 +1,8 @@
![Daisy logo](https://git.utopic.work/PierMesh/piermesh/raw/branch/main/imgs/daisydisplay.png)
Schemaless binary database
base class
==========================
<a id="daisy"></a>
# Daisy
### *class* Daisy.Daisy.Daisy(filepath: str, templates: dict = {}, template: bool = False, prefillDict: bool = False)

View File

@ -1,6 +1,6 @@
<a id="daisy-signal-management"></a>
<a id="soil-daisy-signal-management"></a>
# Daisy signal management
# Soil: Daisy signal management
### *class* Daisy.Soil.Compound(cache, isCatch: bool = False)

View File

@ -1,6 +1,6 @@
Daisy based key value
store with recursion
==========================
<a id="store-daisy-key-value-store"></a>
# Store: Daisy key value store
### *class* Daisy.Store.Store(store: str, path: str, nodeNickname: str)

View File

@ -1,6 +1,6 @@
<a id="base-packet"></a>
<a id="packet-base-packet"></a>
# Base packet
# Packet: Base packet
### *class* Packets.Packet.Packet(data: bytes, packetsID: int = -1, packetNumber=False, packetCount: int = 1, packetsClass: int = -1)

View File

@ -1,6 +1,6 @@
SinglePacket: Singular packet
for very low data applications
===============================
<a id="singlepacket-singular-packet-messages-for-very-low-data-applications"></a>
# SinglePacket: Singular packet messages for very low data applications
### *class* Packets.SinglePacket.SinglePacket(data, packetsID, packetsClass=None, cache=None)

View File

@ -1,6 +1,6 @@
SubPackets for handling
full submessages
=======================
<a id="submessage-additional-data-for-larger-messages"></a>
# SubMessage: Additional data for larger messages
### *class* Packets.SubMessage.SubMessage

View File

@ -1,6 +1,6 @@
SubPacket for handling
individual packets of submessages
=================================
<a id="subpacket-packets-for-submessages"></a>
# SubPacket: Packets for submessages
### *class* Packets.SubPacket.SubPacket

View File

@ -1,6 +1,6 @@
<a id="network-map-representation"></a>
<a id="network-network-map-representation"></a>
# Network map representation
# Network: Network map representation
### *class* Siph.map.Network(file=None)

View File

@ -1,6 +1,6 @@
Primary filtering functionality
Dispatches to Protocols
===============================
<a id="base-primary-filtering-functionality"></a>
# 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
<a id="protocols"></a>
# Protocols
#### *async* bubble.filter(recipient, recipientNode, onodeID, todo)
Peer to peer protol

View File

@ -1,6 +1,6 @@
<a id="layer-0-data-transceiving"></a>
<a id="transceiver-layer-0-data-transceiving"></a>
# Layer 0 data transceiving
# Transceiver: Layer 0 data transceiving
### *class* Transceiver.Transceiver.Transceiver(device, filter, onodeID, cache, catch, cryptographyInfo, cLog)

View File

@ -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,25 +69,27 @@ 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)
* [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`](/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)
* [Daisy signal management](/PierMesh/piermesh/src/branch/main/docs/Daisy/Soil.md)
* [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: 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)
* [`DHEFern`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/WhaleSong.md)
* [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)
@ -107,17 +109,19 @@ sphinx-quickstart on Fri Jul 26 23:30:55 2024. -->
* [`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)
* [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)
* [`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)
* [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)

View File

@ -1,7 +1,6 @@
Diffie hellman ephemeral
Fernet based encryption
==========================
WhaleSong: Diffie hellman ephemeral Fernet based encryption
===========================================================
.. autoclass:: Cryptography.WhaleSong.DHEFern
:members:

View File

@ -1,5 +1,5 @@
Daisy based cache
==========================
=================
.. autoclass:: Daisy.Cache.Cache
:members:

View File

@ -1,7 +1,5 @@
Daisy cache for catchs,
PierMesh's domain analog
==========================
Daisy Catch cache
=================
.. autoclass:: Daisy.Catch.Catch
:members:
:undoc-members:

View File

@ -1,6 +1,5 @@
Schemaless binary database
base class
==========================
Daisy
=====
.. autoclass:: Daisy.Daisy.Daisy
:members:

View File

@ -1,5 +1,5 @@
Daisy signal management
==========================
Soil: Daisy signal management
=============================
.. autoclass:: Daisy.Soil.Compound
:members:

View File

@ -1,6 +1,5 @@
Daisy based key value
store with recursion
==========================
Store: Daisy key value store
============================
.. autoclass:: Daisy.Store.Store
:members:

View File

@ -1,5 +1,5 @@
Base packet
===============================
Packet: Base packet
===================
.. autoclass:: Packets.Packet.Packet
:members:

View File

@ -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:

View File

@ -1,6 +1,5 @@
SubPackets for handling
full submessages
=======================
SubMessage: Additional data for larger messages
===============================================
.. autoclass:: Packets.SubMessage.SubMessage
:members:

View File

@ -1,6 +1,5 @@
SubPacket for handling
individual packets of submessages
=================================
SubPacket: Packets for submessages
==================================
.. autoclass:: Packets.SubPacket.SubPacket
:members:

View File

@ -1,5 +1,5 @@
Network map representation
==========================
Network: Network map representation
===================================
.. autoclass:: Siph.map.Network
:members:

View File

@ -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

View File

@ -1,5 +1,5 @@
Layer 0 data transceiving
===============================
Transceiver: Layer 0 data transceiving
======================================
.. autoclass:: Transceiver.Transceiver.Transceiver
:members: