Commit graph

2507 commits

Author SHA1 Message Date
Richard
107ef80b9e Track documentation images with LFS
PNG images in the docs/ directory will be tracked using LFS, to
avoid the repo becoming unmanageable.
2021-09-21 14:04:08 +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
a611d4f5ce Deploy OpenAPI description properly 2021-09-21 14:04:08 +01:00
Richard Bowman
a2de316e31 Merge branch 'update-js-dependencies' into 'master'
Run `npm audit fix`

See merge request openflexure/openflexure-microscope-server!141
2021-09-16 16:28:16 +00:00
Kaspar Emanuel
9cc26b8060 Merge branch 'hide-smart-stack-controls' into 'master'
Hide smart stack controls when they are not required

See merge request openflexure/openflexure-microscope-server!142
2021-09-16 15:17:42 +00:00
Richard
bb4b7335a3 Hide smart stack controls when they are not required
The code that checked for the presence of the smart stack plugin had a typo,
and would display smart stack controls whenever the stack and scan extension
was detected (whether or not the smart stack extension was enabled).

This is now fixed.
2021-09-16 15:47:11 +01:00
Kaspar Emanuel
f5c01c612b Run npm audit fix 2021-09-16 15:45:12 +01:00
Kaspar Emanuel
0e628e0d53 Merge branch 'move-js' into 'master'
Move Vue app to a "webapp" directory

See merge request openflexure/openflexure-microscope-server!122
2021-09-16 14:37:00 +00:00
Kaspar Emanuel
b2eb1e0f05 Rename js directory to webapp 2021-09-16 15:13:19 +01:00
Richard
375bcf4e73 fix typo in artifact path 2021-09-16 15:13:19 +01:00
Richard
a42e94ce66 Fix JS build artifact
The JS build step was reporting the JS source folder as an artifact.
I've updated it to use the output folder instead.
2021-09-16 15:13:19 +01:00
Kaspar Emanuel
c835bf3b7e Update readme with new js directory 2021-09-16 15:13:18 +01:00
Kaspar Emanuel
caa6284e7d Add missing vue-config 2021-09-16 15:13:18 +01:00
Kaspar Emanuel
dd0b8b9a8b Change static folder to js folder in gitlab-ci 2021-09-16 15:13:17 +01:00
Kaspar Emanuel
13f7252dd7 Move Vue app to a js directory 2021-09-16 15:13:17 +01:00
Richard Bowman
515bee1422 Merge branch 'check-error-in-task-submitter-response' into 'master'
Move error handling for taskSubmitter

See merge request openflexure/openflexure-microscope-server!138
2021-09-07 14:57:25 +00:00
Richard Bowman
74dbbf7d18 Merge branch 'expose-openapi-artifact' into 'master'
Make OpenAPI easier to download from a MR

See merge request openflexure/openflexure-microscope-server!139
2021-09-07 14:56:59 +00:00
Kaspar Emanuel
c5f47c922c Merge branch 'remove-defunct-error-handler' into 'master'
Remove vestigial error handling code

See merge request openflexure/openflexure-microscope-server!137
2021-09-07 13:20:46 +00:00
Richard
5ba285ac15 Make OpenAPI easier to download from a MR 2021-08-26 23:38:27 +01:00
Richard
3d33218072 Move error handling for taskSubmitter
taskSubmitter ended up in a confused state if the initial POST request
encountered an error.
I've updated `startPolling` to return a Promise, and moved the
error handling code to the top level.

This doesn't change anything for the case where we get a non-error
response to the POST request, but means that e.g. 400 errors
get caught and displayed properly.
2021-08-26 23:12:47 +01:00
Richard
ae96340d79 Remove unused import 2021-08-23 20:53:04 +01:00
Richard Bowman
6a484514a9 Remove vestigial error handling code
LabThings now handles HTTPErrors properly, so I am removing
this copy-pasted workaround.
2021-08-23 16:08:50 +01:00
Richard Bowman
76a807fba5 Merge branch 'beta-release-prep' into 'master'
Readme, changelog, version bump

See merge request openflexure/openflexure-microscope-server!136
2021-08-19 07:36:01 +00:00
Richard Bowman
feedda87ed Merge branch 'upload-test-reports' into 'master'
Generate and use pytest XML reports

See merge request openflexure/openflexure-microscope-server!135
2021-08-17 15:30:39 +00:00
Richard Bowman
3e02fe4790 Merge branch 'static-docs' into 'master'
Improved API docs

See merge request openflexure/openflexure-microscope-server!133
2021-08-17 11:33:40 +00:00
Richard Bowman
7860b6eda7 deleted some commented-out extensions 2021-08-17 12:18:10 +01:00
Richard Bowman
040d7d4ba6 Fix action wrapper
The action wrapper was using an unbound function - it
now passes the extension object as self.

We were incorrectly passing endpoint names as positional arguments -
this is fixed and I now use a keyword argument.
2021-08-17 12:11:20 +01:00
Kaspar Emanuel
6d25dcfa9e Merge branch 'smart-stack-controls' into 'master'
Added controls for smart stack

See merge request openflexure/openflexure-microscope-server!134
2021-08-17 09:43:32 +00:00
Richard
8b8572f2f2 Version bump and changelog 2021-08-11 16:02:33 +01:00
Richard
512a06eb5e Update readme
Added instructions for developing on Pi, downloading web app, and
fixed changelog generation (Added npx).
2021-08-11 15:31:19 +01:00
Richard
b7ca9e095c Build and package static web app on master 2021-08-10 17:48:41 +01:00
Richard
e33e92b43a Generate and use pytest XML reports
This generates XML reports when we run pytest through poe, and
uploads them in the relevant CI stage.

I've also ignored mypy cache files - I'm not sure why this hasn't
been an issue before...
2021-08-10 11:29:09 +01:00
Richard
d7d7a8cc8d Blackened test_app.py 2021-08-09 22:01:14 +01:00
Richard
b7c15886e9 Use neater spread operator to copy objects
Rather than Object.assign, I now use the ... operator to
ensure that dictionaries don't pollute each other in computed
properties.
2021-08-09 21:57:52 +01:00
Richard
332ecad19b Update caniuse-lite 2021-08-02 10:31:07 +01:00
Richard
c831937b05 Validate thing description in tests 2021-07-26 02:48:45 +01:00
Richard
5e36837e5f Blackened tests 2021-07-25 22:59:59 +01:00
Richard
89f350cf7e Create docs/build directory in CI 2021-07-25 22:56:47 +01:00
Richard
80cebe3ebc Add test for valid OpenAPI 2021-07-25 22:26:52 +01:00
Richard
fe3fb5c66b Incorporate LabThings 1.3
The necessary changes to produce valid OpenAPI docs are now in
the latest release of LabThings.  This change updates it.

Also, isort was trying to sort my virtual environment, hence
the change to pyproject.toml.
I don't know why that happened - maybe an update to isort?
2021-07-25 22:23:54 +01:00
Richard
3cdfd52a77 Added controls for smart stack 2021-07-25 09:14:33 +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
cfba9d5c09 downgrade pylint
pylint 2.9 seems to die on this code, no idea why. It's a crash in
pylint rather than an error in the code I think.
2021-07-25 03:41:06 +01:00
Richard
9fa545f3fa Typing fix
mypy doesn't like adding attributes to functions, so
I have used the described_operation decorator to
add type hints to the functions.
2021-07-25 03:38:20 +01:00
Richard
a8b1efb7cd Removed openapi endpoints (now in LabThings) 2021-07-25 01:23:44 +01:00
Richard Bowman
e2990b5b38 Bump pylint version and fix to 2.8 to avoid bug
pylint 2.9 crashes - I can't figure out why, but it seems like it's
a bug in pylint rather than an error in our code.
We should try to track it down and get it fixed, I've seen
some similar bug reports on their github, but
all of them should be resolved in 2.9...
2021-07-21 10:49:56 +01:00