From 694f55c0977d2c54fcdfd758d98658b18dfdb369 Mon Sep 17 00:00:00 2001 From: Dgabri Date: Sun, 29 Oct 2023 21:18:07 +0100 Subject: [PATCH] Added python API docs indexing --- python/README.md | 4 ++++ python/docs/python_API_index.md | 8 ++++++++ 2 files changed, 12 insertions(+) create mode 100644 python/docs/python_API_index.md diff --git a/python/README.md b/python/README.md index e95c50b57a..f52f263547 100644 --- a/python/README.md +++ b/python/README.md @@ -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) diff --git a/python/docs/python_API_index.md b/python/docs/python_API_index.md new file mode 100644 index 0000000000..2b4cd5e8ff --- /dev/null +++ b/python/docs/python_API_index.md @@ -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) \ No newline at end of file