Added public documentation (#117)

* Started process of adding project documentation

* Re-wrote contribution document in rst instead of md

* Re-wrote readme using rst

* Started adding API docs

* Attempt at enabling rtd

* Added branch to docs for testing

* Fix docs build directory

* Add pymavswarm build to docs pipeline

* what a helpful warning; attempt 1?

* Set fail fast to false

* Found ya

* pain

* Removed testing branch from docs pipeline

* Started process of adding examples

* Resolved errors with api docs being generated

* Updated examples documentation

* Added support for rst checks to pre-commit

* Add documentation build configuration

* Fix os version in rtd build

* Fix docs source reference in rtd build config

* Add pymavswarm build to rtd build

* pain

* Pain

* Removed tests and types pages

* added docs build status to readme

* Cleaned up docs directory structure

* nvm

* Updated pipenv

Author: evan-palmer

.devcontainer/Dockerfile

@@ -46,13 +46,17 @@ RUN pip3 install \
     bandit \
     coverage \
     pre-commit \
-    tox
+    tox \
+    rstcheck
 
 # Install required packaging and deployment tools
 RUN pip3 install \
     build \
     twine \
-    check-wheel-contents
+    check-wheel-contents \
+    sphinx \
+    furo \
+    sphinx-autobuild
 
 # Install visualization tools
 RUN pip3 install \

.devcontainer/devcontainer.json

@@ -64,10 +64,6 @@
         "source.organizeImports": true
       }
     },
-    "[markdown]": {
-      "editor.rulers": [80],
-      "editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
-    },
     "[dockerfile]": {
       "editor.quickSuggestions": {
         "strings": true
@@ -93,11 +89,13 @@
     "ms-python.python",
     "njpwerner.autodocstring",
     "ms-python.vscode-pylance",
-    "DavidAnson.vscode-markdownlint",
     "esbenp.prettier-vscode",
     "LittleFoxTeam.vscode-python-test-adapter",
     "tamasfe.even-better-toml",
-    "alefragnani.Bookmarks"
+    "alefragnani.Bookmarks",
+    "lextudio.restructuredtext",
+    "trond-snekvik.simple-rst",
+    "ritwickdey.LiveServer"
   ],
-  "postStartCommand": "pip3 install -e ."
+  "postStartCommand": "python3 -m pip install -e ."
 }