Refresh Documentation

docs/.markdownlint.json

@@ -0,0 +1,3 @@
+{
+  "MD033": false
+}

docs/Dockerfile

@@ -0,0 +1,5 @@
+FROM sphinxdoc/sphinx
+
+WORKDIR /docs
+RUN pip3 install myst-parser sphinx-design furo linkify-it-py
+

docs/README.md

@@ -1,3 +1,20 @@
 # Fieldmark Documentation
 
-This is suport documentation for users wanting to learn about the Fieldmark Webapp, Android and iOS versions.
+This directory contains two collections of documentation for Fieldmark.
+The `docs` folder contains user facing documentation.  The
+[developer](developer/README.md) folder contains internal developer documentation.
+
+## Building User Facing Documentation
+
+Documentation can be built locally using Sphinx or via a docker image. To
+build the local docker image with sphinx plugins installed:
+
+```bash
+docker build . -t faims-sphinx
+```
+
+To build the documentation: 
+
+```bash
+docker run --rm -v ./docs:/docs faims-sphinx make html
+```

docs/developer/README.md

@@ -5,3 +5,5 @@ of FAIMS for developers.  It is separate from user facing documentation
 in the `docs` folder and is not intended for separate publication.
 
 * [Adding New Field Types](Fields.md)
+* [Configuration of the Mobile App](Configuration.md)
+* [Android Deployment](Android-Deployment.md)

docs/docs/conf.py

@@ -7,7 +7,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "Fieldmark"
-copyright = "2023, Electronic Field Notebooks Pty Ltd"
+copyright = "2024, Electronic Field Notebooks Pty Ltd"
 author = "Electronic Field Notebooks Pty Ltd"
 release = "0.7.940"