rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

First attempt at fixing readthedocs

Browse source 
This removes the API documentation - we will render it separately.
This commit is contained in:
Richard Bowman 2021-08-19 16:12:58 +01:00 • committed by Richard
parent a611d4f5ce
commit 1cd097b7aa
3 changed files with 3 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/requirements.txt
View file

@ -1,2 +1 @@
sphinxcontrib.httpdomain
sphinx_rtd_theme sphinx_rtd_theme

9
docs/source/api.rst
View file

@ -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``. 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_ .. _`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
.. openapi:: ../build/swagger.yaml
.. _ReDoc: api_redoc.html

2
docs/source/conf.py
View file

@ -68,8 +68,6 @@ extensions = [
"sphinx.ext.viewcode", "sphinx.ext.viewcode",
"sphinx.ext.githubpages", "sphinx.ext.githubpages",
"sphinx.ext.ifconfig", "sphinx.ext.ifconfig",
"sphinxcontrib.openapi",
"sphinxcontrib.redoc",
] ]
# Override ordering # Override ordering