diff --git a/docs/requirements.txt b/docs/requirements.txt index 9aa2c29a..52b04f2e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1 @@ -sphinxcontrib.httpdomain sphinx_rtd_theme \ No newline at end of file diff --git a/docs/source/api.rst b/docs/source/api.rst index f33d32a0..f2ffdac2 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -6,10 +6,7 @@ Live documentation Full, interactive Swagger documentation for your microscopes web API is available from the microscope itself. From any browser, go to ``http://{your microscope IP address}/api/v2/docs/swagger-ui``. -.. note:: We should have an online copy of the API SwaggerUI documentation up soon. +The API is described in an OpenAPI description, available at ``http://{your microscope IP address}/api/v2/docs/openapi.yaml``. It is also available from our `build server`_. It can be conveniently viewed using Redoc, for example `link to test OpenAPI rendering`_ -The API is now also detailed below, or there is a more interactive version of the docs statically compiled using ReDoc_ - -.. openapi:: ../build/swagger.yaml - -.. _ReDoc: api_redoc.html \ No newline at end of file +.. _`build server`: https://build.openflexure.org/openflexure-microscope-server/ +.. _`link to test OpenAPI rendering`: https://redocly.github.io/redoc/?url=https://build.openflexure.org/temp/rwb34/swagger.yaml \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index e3550325..c6495bc0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -68,8 +68,6 @@ extensions = [ "sphinx.ext.viewcode", "sphinx.ext.githubpages", "sphinx.ext.ifconfig", - "sphinxcontrib.openapi", - "sphinxcontrib.redoc", ] # Override ordering