Maagan-Michael / net-n

Micro ISP management system
https://maagan-michael.github.io/net-n/
MIT License
1 stars 2 forks source link

Roadmap v1 #17

Open nathanschwarz opened 11 months ago

nathanschwarz commented 11 months ago

Backend : app configuration :

job queue :

IMC adapter:

SwitchOutput in the API (pydantic) :

Customer assignation (in "/upsert" and "/assign"):

Customer deletion :

Switch mutation :

Switch deletion :

Unit tests :

SyncModule : Doc :

Unit tests :

Frontend :

yarons commented 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?

nathanschwarz commented 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?

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.

yarons commented 11 months ago

I'm not sure but maybe this will cover: https://www.reddit.com/r/Python/comments/fqjxpp/i_created_an_autodoc_plugin_for_mkdocs/