diff --git a/README.md b/README.md index 7067dcb4a7686030b9ed926ed06df5f1c21ee0a6..e8216dd6425d784fec8fd47e769f0ce8452ed0ce 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 df7036adbabff8c35b79ac5166333c5ddd26d10d..5aa8fc17646cf7d2ca78598f90935fbde188b997 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 72531fd8f43f4c748df910f204b6342c7a0d0d7b..2f7eec7d0b0a05a141cc242bc4ad598e3df2e153 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 866f98e135cf58dcee02accb6071cd09e7b31e35..bd1707eb25075c637cca7a33827fdc5a7ef9b79b 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 ---------------------------------