vrr/ntopng
2
0
Fork 0
mirror of https://github.com/ntop/ntopng.git synced 2026-08-11 01:13:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Added python API docs indexing

Browse source
This commit is contained in:
Dgabri 2023-10-29 21:18:07 +01:00
parent 1b73a56dd5
commit 694f55c097
2 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
python/README.md
View file

@ -45,6 +45,10 @@ We encourage our users to extend this API. For your convenience we are sharing a
Documentation
-------------
For detailed documentation on each API class please visit:
- [Python API Docs] (https://github.com/ntop/ntopng/blob/dev/python/docs/python_API_index.md)
For further information please visit the API documentation available at:
[ntopng Python API](https://www.ntop.org/guides/ntopng/api/python/index.html)

8
python/docs/python_API_index.md Normal file
View file

@ -0,0 +1,8 @@
# Ntopng Python API docs
Inside this folder you can find documentation on how to use the ntopng python API, please refer to these resources to learn more:
- [Historical] (https://github.com/ntop/ntopng/blob/dev/python/docs/python_API_Historical.md)
- [Host] (https://github.com/ntop/ntopng/blob/dev/python/docs/python_API_Host.md)
- [Network_Interface] (https://github.com/ntop/ntopng/blob/dev/python/docs/python_API_interface.md)
- [Ntopng] (https://github.com/ntop/ntopng/blob/dev/python/docs/python_API_ntopng.md)