Open nathanschwarz opened 11 months ago
Regarding the HTML documentation? Can you add an explanation on how to do it and I'll try to see if there are any alternatives?
Regarding the HTML documentation? Can you add an explanation on how to do it and I'll try to see if there are any alternatives?
The HTML documentation generated for the sync module was generated with pdoc3
.
It's simple as :
pip install pdoc3
pdoc3 path_to_module
Unfortunately pdoc3 doesn't generate documentation for pydantic models and descriptions.
I'm not sure but maybe this will cover: https://www.reddit.com/r/Python/comments/fqjxpp/i_created_an_autodoc_plugin_for_mkdocs/
Backend : app configuration :
pydantic
model (this way the configuration can be precisely described in the documentation)job queue :
IMC adapter:
SwitchOutput in the API (pydantic) :
Customer assignation (in "/upsert" and "/assign"):
connection.autoUpdate == True
)Customer deletion :
connection.autoUpdate == True
)Switch mutation :
restrictedPorts
has changed, find and update theconnection.autoUpdate = False
accordinglySwitch deletion :
Unit tests :
SyncModule : Doc :
Unit tests :
Frontend :