Skip to content

Commit 9679296

Browse files
annavikannavik
committed
Merge branch 'main' into feat/include-rename-instructions
2 parents a335e22 + 7c904e0 commit 9679296

9 files changed

Lines changed: 46 additions & 23 deletions

File tree

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ local-check-links: ## Check links in markdown files locally using a docker image
7878
## -- Docs targets -------------------------------------------------------------------------------------------------- ##
7979
.PHONY: preview-docs
8080
preview-docs: ## Preview the documentation site locally
81-
@poetry run mkdocs serve -a 0.0.0.0:7000
81+
@poetry run mkdocs serve
8282

8383

8484
.PHONY: build-docs

‎docs/css/extra.css‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.video {
2+
aspect-ratio: 16/9;
3+
border: none;
4+
width: 100%;
5+
}

‎docs/sections/user-guide/processing-data.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# Processing data
22

3-
##
3+
!!! note
4+
5+
Batch processing is currently in development and problems are likely to occur. If you need data processed, we recommend to reach out to the team for support. Thank you for your patience!
6+
7+
## Demo
8+
9+
<iframe allowfullscreen class="video" src="https://drive.google.com/file/d/18xpQM6FBfjdxnGargvLl598gr-10ytrY/preview" />

‎docs/sections/user-guide/project-creation.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# Creating a project
22

3-
##
3+
## Demo
4+
5+
<iframe allowfullscreen class="video" src="https://drive.google.com/file/d/10NQGaCEiDCQ-pAsP9vmdIyMZQx21TLCk/preview" />

‎docs/sections/user-guide/uploading-data.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Uploading data
22

3+
## Configuring a data source
4+
5+
### Demo
6+
7+
<iframe allowfullscreen class="video" src="https://drive.google.com/file/d/1pnUeMtSXcA-aC7G7JiHDwW5gaGPeG6dl/preview" />
8+
39
## Image requirements
410
511
Valid image formats are PNG, GIF and JPEG. Image filenames must contain a timestamp with year, month, day, hours, minutes and seconds (e.g. 20210101120000-snapshot.jpg). The timestamp in the filename makes it possible to do fast indexing of files, which is helpful when reading a large amount of images from a remote storage.
@@ -38,7 +44,3 @@ photo-renamer "path/to/photos" --inplace
3844
```
3945
4046
For more options, checkout the [utility documention](https://github.com/mihow/ami-camera-utils).
41-
42-
### Demo
43-
44-
Coming soon!

‎docs/sections/user-guide/validating-data.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# Validating data
22

3-
##
3+
## Demo
4+
5+
<iframe allowfullscreen class="video" src="https://drive.google.com/file/d/1Odamyg6Tb0xYL4KjxOsw0GX44Btxggf9/preview" />

‎mkdocs.yml‎

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,22 @@ site_name: Antenna Platform Documentation
22

33
nav:
44
- User Guide:
5-
- sections/user-guide/account-creation.md
6-
- sections/user-guide/project-creation.md
7-
- sections/user-guide/uploading-data.md
8-
- sections/user-guide/reviewing-data.md
9-
- sections/user-guide/processing-data.md
10-
- sections/user-guide/browsing-processed-data.md
11-
- sections/user-guide/validating-data.md
12-
- sections/user-guide/visualizing-data.md
13-
- sections/user-guide/exporting-data.md
5+
- sections/user-guide/account-creation.md
6+
- sections/user-guide/project-creation.md
7+
- sections/user-guide/uploading-data.md
8+
- sections/user-guide/reviewing-data.md
9+
- sections/user-guide/processing-data.md
10+
- sections/user-guide/browsing-processed-data.md
11+
- sections/user-guide/validating-data.md
12+
- sections/user-guide/visualizing-data.md
13+
- sections/user-guide/exporting-data.md
1414
- Developer Guide:
15-
- sections/dev-guide/developer-guide.md
15+
- sections/dev-guide/developer-guide.md
1616

17-
theme: readthedocs
17+
theme: readthedocs
18+
19+
markdown_extensions:
20+
- admonition
21+
22+
extra_css:
23+
- css/extra.css

‎poetry.lock‎

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ license = "MIT"
77
readme = "README.md"
88

99
[tool.poetry.dependencies]
10-
python = ">=3.10,<3.13"
10+
python = ">=3.10,<3.13.3"
1111
mkdocs = "^1.6.1"
1212

1313
[tool.poetry.group.dev.dependencies]

0 commit comments

Comments
 (0)