Merge pull request #94 from decargroup/add_docs_testing

Added automatic documentation tests on PRs

.github/workflows/test_docs.yml

@@ -0,0 +1,23 @@
+name: Test Documentation Build
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          pip install -e .
+          pip install sphinx
+          pip install pydata-sphinx-theme
+      - name: Sphinx build
+        run: |
+          cd docs
+          make html

README.rst

@@ -1,8 +1,17 @@
 navlie
-=====
+======
 .. image:: https://github.com/decargroup/navlie/actions/workflows/test_package.yml/badge.svg
     :target: https://github.com/decargroup/navlie/actions/workflows/test_package.yml
     :alt: Tests
+
+
+.. image:: https://github.com/decargroup/navlie/actions/workflows/publish_docs.yml/badge.svg
+    :target: https://github.com/decargroup/navlie/actions/workflows/publish_docs.yml
+    :alt: Docs
+
+.. image:: https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10-blue
+    :target: https://www.python.org/downloads/
+    :alt: Python Version
 
 An on-manifold state estimation library for robotics.
 
@@ -133,8 +142,6 @@ Process and Measurement Models
 ------------------------------
 .. image:: system_diagram.png
     :alt: System Diagram
-.. image:: ./docs/source/system_diagram.png
-    :alt: System Diagram
 
 There are a few more core types in this package. The main ones are the `ProcessModel` and `MeasurementModel` classes. Both of these are abstract classes requiring the user to implement
 

docs/source/index.rst

@@ -3,14 +3,12 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-
-.. include:: ../../README.rst
+Welcome to navlie's documentation!
 
 .. toctree::
    :maxdepth: 1
    :hidden:
 
-   Home <self>
    Tutorial <tutorial>
    API <api>