From 07a3f9848162567bd41243c2853bb8882c27a7cf Mon Sep 17 00:00:00 2001 From: Charles Cossette Date: Sat, 26 Aug 2023 17:10:35 -0400 Subject: [PATCH 1/3] Added automatic documentation tests on PRs --- .../{autobuild.yml => publish_docs.yml} | 0 .github/workflows/test_docs.yml | 29 +++++++++++++++++++ README.rst | 9 ++++-- docs/source/index.rst | 4 +-- 4 files changed, 36 insertions(+), 6 deletions(-) rename .github/workflows/{autobuild.yml => publish_docs.yml} (100%) create mode 100644 .github/workflows/test_docs.yml diff --git a/.github/workflows/autobuild.yml b/.github/workflows/publish_docs.yml similarity index 100% rename from .github/workflows/autobuild.yml rename to .github/workflows/publish_docs.yml diff --git a/.github/workflows/test_docs.yml b/.github/workflows/test_docs.yml new file mode 100644 index 00000000..5b04b60b --- /dev/null +++ b/.github/workflows/test_docs.yml @@ -0,0 +1,29 @@ +name: Test Documentation Build + +on: + push: + branches: [add_docs_testing] # for testing + pull_request: + branches: [main] + +jobs: + build: + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + python-version: ['3.8', '3.9', '3.10'] + 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 diff --git a/README.rst b/README.rst index 2c304530..f685a3ec 100644 --- a/README.rst +++ b/README.rst @@ -1,8 +1,13 @@ 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 An on-manifold state estimation library for robotics. @@ -133,8 +138,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 diff --git a/docs/source/index.rst b/docs/source/index.rst index bf47e08d..2d86b975 100644 --- a/docs/source/index.rst +++ b/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 Tutorial API From c2598e804d83770b33af650656ff1450def62f02 Mon Sep 17 00:00:00 2001 From: Charles Cossette Date: Sat, 26 Aug 2023 17:14:58 -0400 Subject: [PATCH 2/3] added badges to readme --- .github/workflows/test_docs.yml | 2 -- README.rst | 4 ++++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/test_docs.yml b/.github/workflows/test_docs.yml index 5b04b60b..d82d703b 100644 --- a/.github/workflows/test_docs.yml +++ b/.github/workflows/test_docs.yml @@ -1,8 +1,6 @@ name: Test Documentation Build on: - push: - branches: [add_docs_testing] # for testing pull_request: branches: [main] diff --git a/README.rst b/README.rst index f685a3ec..7cc50db2 100644 --- a/README.rst +++ b/README.rst @@ -8,6 +8,10 @@ navlie .. 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. From f1f9d6f84289088c676e505e3579bcac77ad6e32 Mon Sep 17 00:00:00 2001 From: Charles Cossette Date: Sat, 26 Aug 2023 17:16:32 -0400 Subject: [PATCH 3/3] remove excessive python versions from docs tests --- .github/workflows/test_docs.yml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/workflows/test_docs.yml b/.github/workflows/test_docs.yml index d82d703b..21a640ab 100644 --- a/.github/workflows/test_docs.yml +++ b/.github/workflows/test_docs.yml @@ -7,10 +7,6 @@ on: jobs: build: runs-on: ubuntu-latest - strategy: - fail-fast: false - matrix: - python-version: ['3.8', '3.9', '3.10'] steps: - uses: actions/checkout@v3 - uses: actions/setup-python@v3