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.
This commit is contained in:
Richard 2021-09-21 13:55:29 +01:00
parent a09d2411a0
commit 151d9f1bc0
5 changed files with 25 additions and 19 deletions

View file

@ -34,7 +34,21 @@ class Mock(MagicMock):
return MagicMock()
mock_imports = ["picamerax", "picamerax.array", "picamerax.mmalobj"]
mock_imports = [
"picamerax",
"picamerax.array",
"picamerax.mmalobj",
"numpy",
"labthings",
"labthings.json",
"expiringdict",
"dateutil",
"dateutil.parser",
"typing_extensions",
"PIL",
"sangaboard",
"piexif",
]
sys.modules.update((mod_name, Mock()) for mod_name in mock_imports)
@ -235,13 +249,3 @@ intersphinx_mapping = {
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
# -- Options for redoc extension ---------------------------------------------
redoc = [
{
"name": "OpenFlexure Microscope HTTP API",
"page": "api_redoc",
"spec": "../build/swagger.yaml",
"embed": True,
}
]