From 9c716caf2c3469b9bbdba9a308fd0b0f7f6054ab Mon Sep 17 00:00:00 2001 From: Neil Lathwood Date: Sat, 10 Jan 2015 00:23:25 +0000 Subject: [PATCH] Updating docs for RTD --- doc/API/API-Docs.md | 61 +++++++++++++++++++++++---------------------- doc/_Sidebar.md | 25 ------------------- 2 files changed, 31 insertions(+), 55 deletions(-) delete mode 100644 doc/_Sidebar.md diff --git a/doc/API/API-Docs.md b/doc/API/API-Docs.md index db09bb93cc..c6f3976d90 100644 --- a/doc/API/API-Docs.md +++ b/doc/API/API-Docs.md @@ -1,35 +1,36 @@ +- API -- [`structure`](#api-structure) - - [`versioning`](#api-versioning) - - [`token`](#api-tokens) - - [`end-points`](#api-end_points) - - [`input`](#api-input) - - [`output`](#api-output) +- [`Structure`](#api-structure) + - [`Versioning`](#api-versioning) + - [`token`](#api-tokens) + - [`end-points`](#api-end_points) + - [`input`](#api-input) + - [`output`](#api-output) - [`endpoints`](#api-endpoints) - - [`devices`](#api-devices) - - [`del_device`](#api-route-2) - - [`get_device`](#api-route-3) - - [`get_graphs`](#api-route-5) - - [`get_graph_generic_by_hostname`](#api-route-6) - - [`get_port_graphs`](#api-route-7) - - [`get_port_stats_by_port_hostname`](#api-route-8) - - [`get_graph_by_port_hostname`](#api-route-9) - - [`list_devices`](#api-route-10) - - [`add_device`](#api-route-11) - - [`routing`](#api-routing) - - [`list_bgp`](#api-route-1) - - [`switching`](#api-switching) - - [`get_vlans`](#api-route-4) - - [`alerts`](#api-alerts) - - [`get_alert`](#api-route-12) - - [`ack_alert`](#api-route-13) - - [`list_alerts`](#api-route-14) - - [`rules`](#api-rules) - - [`get_alert_rule`](#api-route-15) - - [`delete_rule`](#api-route-16) - - [`list_alert_rules`](#api-route-17) - - [`add_rule`](#api-route-18) - - [`edit_rule`](#api-route-19) + - [`devices`](#api-devices) + - [`del_device`](#api-route-2) + - [`get_device`](#api-route-3) + - [`get_graphs`](#api-route-5) + - [`get_graph_generic_by_hostname`](#api-route-6) + - [`get_port_graphs`](#api-route-7) + - [`get_port_stats_by_port_hostname`](#api-route-8) + - [`get_graph_by_port_hostname`](#api-route-9) + - [`list_devices`](#api-route-10) + - [`add_device`](#api-route-11) + - [`routing`](#api-routing) + - [`list_bgp`](#api-route-1) + - [`switching`](#api-switching) + - [`get_vlans`](#api-route-4) + - [`alerts`](#api-alerts) + - [`get_alert`](#api-route-12) + - [`ack_alert`](#api-route-13) + - [`list_alerts`](#api-route-14) + - [`rules`](#api-rules) + - [`get_alert_rule`](#api-route-15) + - [`delete_rule`](#api-route-16) + - [`list_alert_rules`](#api-route-17) + - [`add_rule`](#api-route-18) + - [`edit_rule`](#api-route-19) Describes the API structure. diff --git a/doc/_Sidebar.md b/doc/_Sidebar.md deleted file mode 100644 index 699cfb590b..0000000000 --- a/doc/_Sidebar.md +++ /dev/null @@ -1,25 +0,0 @@ -- **[[Home]]** -- **General** - - [[Observium Welcome]] - - [[Contributing]] - - [[Updating]] - - [[Roadmap]] - - [[Developing for LibreNMS]] - - [[Credits]] -- **Installation** - - [[Installation (Debian Ubuntu)]] - - [[Installation (RHEL CentOS)]] - - [[Installation Lighttpd (Debian Ubuntu)]] -- **Extensions** - - [[Billing Module]] - - [[Email Alerting]] - - [[IRC Bot]] - - [[IRC Bot Extensions]] - - [[Plugin System]] - - [[Interface Description Parsing]] - - [[Agent Setup]] - - [[Alerting]] - - [[Two Factor Auth]] -- **API** - - [[API Docs]] -