From 98d1d1571a130063725c60b28043de11b24f586b Mon Sep 17 00:00:00 2001 From: Erik Reid <erik.reid@geant.org> Date: Mon, 25 Jan 2021 08:51:30 +0100 Subject: [PATCH] added some local toc's and a link to jenkins in README --- README.md | 5 ++++- docs/source/protocol/classifier.rst | 2 ++ docs/source/protocol/data.rst | 2 ++ docs/source/protocol/jobs.rst | 2 ++ 4 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7067dcb4..e8216dd6 100644 --- a/README.md +++ b/README.md @@ -9,4 +9,7 @@ Documentation can be generated by running sphinx: ```bash sphinx-build -M html docs/source docs/build -``` \ No newline at end of file +``` + +The documents should be viewable in the +workspace of the most recent [Jenkins job](https://jenkins.geant.org/job/inventory-provider%20(develop)/ws/docs/build/html/index.html). \ No newline at end of file diff --git a/docs/source/protocol/classifier.rst b/docs/source/protocol/classifier.rst index df7036ad..5aa8fc17 100644 --- a/docs/source/protocol/classifier.rst +++ b/docs/source/protocol/classifier.rst @@ -6,6 +6,8 @@ Classifier Endpoints These endpoints are intended for use by Dashboard V3. +.. contents:: :local: + /classifier/peer-info --------------------- diff --git a/docs/source/protocol/data.rst b/docs/source/protocol/data.rst index 72531fd8..2f7eec7d 100644 --- a/docs/source/protocol/data.rst +++ b/docs/source/protocol/data.rst @@ -6,6 +6,8 @@ Data Endpoints These endpoints are temporary and will be removed. +.. contents:: :local: + /data/routers --------------------------------- diff --git a/docs/source/protocol/jobs.rst b/docs/source/protocol/jobs.rst index 866f98e1..bd1707eb 100644 --- a/docs/source/protocol/jobs.rst +++ b/docs/source/protocol/jobs.rst @@ -6,6 +6,8 @@ Jobs Endpoints These endpoints are used for monitoring running jobs. +.. contents:: :local: + /jobs/update --------------------------------- -- GitLab