Richard
67b57727f6
Format fixes
2021-09-21 17:45:17 +01:00
Richard
3971a92a5f
Install more dependencies
...
This commit fixes a couple of errors in the Sphinx docs, by
removing mock imports and replacing them with real ones.
2021-09-21 17:38:15 +01:00
Richard
f0fcd53487
Update link to openapi documentation
2021-09-21 15:41:29 +01:00
Richard
ebf8376bd4
Formatting fixes
2021-09-21 14:48:41 +01:00
Richard
72c060c213
Workaround for LFS images
...
There is now code in `conf.py` to install git LFS and to check images
are correctly fetched.
2021-09-21 14:22:22 +01:00
Richard
151d9f1bc0
Various fixes to docs
...
I've added a lot more mock imports so the automatic documentation now works.
I've updated the links between pages (removing .rst extension) so they work.
I've added a link to the settings pane image.
2021-09-21 14:04:08 +01:00
Richard
a09d2411a0
Add documentation of the web app
...
A first pass of documentation describing the web app GUI. Screenshots
are committed as LFS objects, I've been deliberately conservative here
(only png files in the docs/ directory are LFSed) to avoid messing
with any static files in the web app.
2021-09-21 14:04:08 +01:00
Richard
3b40ae9918
Don't build OpenAPI automatically
...
Readthedocs won't be able to build OpenAPI, so I've removed this from
the makefile.
2021-09-21 14:04:08 +01:00
Richard Bowman
1cd097b7aa
First attempt at fixing readthedocs
...
This removes the API documentation - we will render it separately.
2021-09-21 14:04:08 +01:00
Richard Bowman
7860b6eda7
deleted some commented-out extensions
2021-08-17 12:18:10 +01:00
Richard
1d16792681
Removing unnecessary validation code
...
I wrote test_swagger_yaml before I realised I could
validate the API with apispec directly.
2021-07-25 03:45:16 +01:00
Richard
b6228ba2d5
Removed unnecessary node junk
...
I'd briefly installed some node utilities in docs/
These are not needed, so I'm removing the associated .gitignore
2021-07-25 03:44:26 +01:00
Richard
b7c9d3b73b
Sorted remaining content_type issues and blackened
2021-07-19 20:09:09 +01:00
Richard
8422e8bfef
ignore local installation of swagger-cli
2021-07-13 22:54:11 +01:00
Richard
65f5a69bad
fix openapi response in docs
2021-07-13 22:49:06 +01:00
Richard
19abfff061
Add HTTP API to docs
2021-07-06 15:26:27 +01:00
Richard
1e21ce51fc
Some basic validation for OpenAPI
...
I was getting unhelpful OpenAPI errors, this Python script makes it easier
to figure out where they come from.
2021-07-06 15:18:53 +01:00
Richard
8157fa6d58
Add YAML export from APISpec
2021-06-27 21:08:48 +01:00
Joel Collins
8b20975cb9
Formatting
2020-11-30 17:11:37 +00:00
Joel Collins
f849afd2c2
Clarified LABTHINGS_EXTENSIONS in docs
2020-11-30 16:45:43 +00:00
Joel Collins
bacc111a87
Updated documentation to subclass-based extensions
2020-11-30 16:23:28 +00:00
Joel Collins
9f5252194a
Updated all log strings to new format
2020-11-12 15:12:17 +00:00
Joel Collins
2bfb988460
Code formatting
2020-10-13 15:02:19 +01:00
Joel Collins
e49c6c6e8e
Close #172
2020-09-30 12:31:49 +01:00
Joel Collins
2ce58f2aee
Merge branch 'master' of https://gitlab.com/openflexure/openflexure-microscope-server
2020-09-07 16:33:01 +01:00
Joel Collins
54c342bbbb
Switch to picamerax
2020-09-07 16:31:59 +01:00
Joel Collins
5139b24ffe
Updated to new LabThings structure
2020-09-04 15:48:52 +01:00
Joel Collins
24398ba7dc
Updated tasks nomenclature
2020-07-21 12:54:42 +01:00
Joel Collins
d406b03354
Fixed swagger-ui links
2020-07-15 16:03:14 +01:00
Joel Collins
3100530edb
Fixed leftover decorator references
2020-06-29 17:49:01 +01:00
Joel Collins
9ae2ae06d0
Updated documentation to LT070 style
2020-06-29 17:47:51 +01:00
Joel Collins
1819ca6a9c
Switched to ActionView and PropertyView from decorators
2020-05-26 10:54:21 +01:00
Joel Collins
eaf4cf09f5
Updated to new Action tasks
2020-05-12 11:29:53 +01:00
Joel Collins
f292ff3e43
Revert "Added sleeps to check for blank capture fix"
...
This reverts commit 32ddcd5d13
2020-04-07 11:03:26 +00:00
Joel Collins
6476778673
Merge remote-tracking branch 'origin/master' into v2.1.0-dev
2020-03-25 17:00:55 +00:00
Joel Collins
7c59245753
Merge branch 'master' into 'rwb27-plugin-comments'
...
# Conflicts:
# docs/source/extensions/structure.rst
2020-03-24 11:17:11 +00:00
Joel Collins
4626fa0565
Added docs for subclassing and lifecycle hooks
2020-03-24 10:22:39 +00:00
Joel Collins
6b14ea8395
Moved viewPanel into top-level of extension GUI
2020-03-18 17:51:55 +00:00
Joel Collins
b7c3f7b9e1
Added viewPanel GUI property
2020-03-17 14:23:52 +00:00
Richard Bowman
d36b82ac77
fixed dead link to cli instructions
2020-02-17 12:26:50 +00:00
Joel Collins
9b4bf4c8fc
Moved status routes to instrument/state
2020-01-29 17:43:52 +00:00
jtc42
6df7fe9405
Blackened
2020-01-24 15:41:33 +00:00
Richard Bowman
b048ece777
fixed a couple of trivial typos
2020-01-23 09:32:34 +00:00
jtc42
1eda70045c
Removed old plugin docs
2020-01-22 16:36:59 +00:00
jtc42
58123a76c2
Removed Flask autodocs
2020-01-22 16:36:53 +00:00
jtc42
b6ffd7740d
Reordered GUI dict to match docs
2020-01-22 16:36:44 +00:00
jtc42
be8d94e718
Wrote tasks and locks sections
2020-01-22 15:17:47 +00:00
jtc42
6520db75f6
Wrote W3C sections
2020-01-22 15:17:40 +00:00
jtc42
1115d00a18
Moved example extension and switched to includes
2020-01-22 15:17:31 +00:00
jtc42
d2780f5541
Added marshaling section to docs
2020-01-22 11:10:52 +00:00