From 7cce823bd1c2473bba378bc908489b9ea6736666 Mon Sep 17 00:00:00 2001 From: Julian Stirling Date: Thu, 12 Feb 2026 16:36:55 +0000 Subject: [PATCH] Show both http and python api on pages --- .gitignore | 3 +- .gitlab-ci.yml | 2 + apidocs/http/index.html | 87 +++++++++++++++++++++++++++++++++++++++++ apidocs/index.html | 60 ++++++++++++++++++++++++++++ 4 files changed, 151 insertions(+), 1 deletion(-) create mode 100644 apidocs/http/index.html create mode 100644 apidocs/index.html diff --git a/.gitignore b/.gitignore index d51d9650..582845f5 100644 --- a/.gitignore +++ b/.gitignore @@ -65,7 +65,8 @@ picamera_test_hashes.json *.log # Documentation -apidocs +apidocs/python +apidocs/http/*.json # PyBuilder target/ diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index f46e56af..7f20d205 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -180,11 +180,13 @@ build-docs: - | pydoctor -W \ --docformat restructuredtext \ + --html-output apidocs/python \ --project-name "OpenFlexure Microscope Server" \ --project-version $CI_COMMIT_REF_NAME \ --theme readthedocs \ --html-viewsource-base https://gitlab.com/openflexure/openflexure-microscope-server/-/tree/$CI_COMMIT_SHA/ \ src/openflexure_microscope_server + - ./generate_http_api_data.py - echo "JOB_ID=$CI_JOB_ID" > build-docs.env artifacts: expire_in: 1 week diff --git a/apidocs/http/index.html b/apidocs/http/index.html new file mode 100644 index 00000000..bb34ec7c --- /dev/null +++ b/apidocs/http/index.html @@ -0,0 +1,87 @@ + + + + OpenFlexure Microscope HTTP API Docs + + + + + + + + + +
+

OpenFlexure Microscope HTTP API

+ +

+ These docs are provided for reference only. They cannot control a running microscope. +

+ +

+ For interactive documentation on a live microscope, visit: +
+ http://microscope.local:5000/docs +

+ + +
+ +
+ + + + + + diff --git a/apidocs/index.html b/apidocs/index.html new file mode 100644 index 00000000..f2afdc03 --- /dev/null +++ b/apidocs/index.html @@ -0,0 +1,60 @@ + + + + + +OpenFlexure Microscope Server API Docs + + + + + + + + +
+

OpenFlexure Microscope Server API Docs

+

Select documentation:

+ + HTTP API (Swagger) + Python API +
+ + +