From 48d2e2bdccdb8bf87548535563c4edffa0dc5f25 Mon Sep 17 00:00:00 2001 From: peter Date: Sun, 8 Feb 2026 18:19:05 +0100 Subject: [PATCH 1/2] fix docs generation in CI --- .github/workflows/deploy-web.yaml | 2 ++ CONTRIBUTING.md | 4 ++-- docs/CONTRIBUTING.md | 4 ++-- docs/README.md | 2 ++ 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/workflows/deploy-web.yaml b/.github/workflows/deploy-web.yaml index 3933949..dfb28af 100644 --- a/.github/workflows/deploy-web.yaml +++ b/.github/workflows/deploy-web.yaml @@ -19,6 +19,8 @@ jobs: - uses: actions/setup-python@v5 with: python-version: "3.12" + - name: Install Hathch + run: pip install hatch - uses: actions/cache@v4 with: key: mkdocs-${{ github.ref }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 10cd64b..e9fef41 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -142,10 +142,10 @@ with pyspacemouse.open(device_spec=device_spec) as device: See [Custom Device Configuration](https://spacemouse.kubaandrysek.cz/mouseApi/#custom-device-configuration) for more details. ## How to write documentation -To install the required dependencies, run `pip install pyspacemouse[docs]`. +To install the required dependencies, run `make install-dev`, and please also install `doxygen` manually. Edit `README.md` only in the root folder. The documentation is automatically generated from `README.md` and `docs/` folder. -To update documentation from root to `/docs` use macro `make fixRelativeLinkDocs` which will replace all relative links from `/` to `/docs` folder. +To update documentation from root to `/docs`, use `make docs-build`. ### Building the documentation The documentation is built using [mkdocs](https://www.mkdocs.org/). To test the documentation locally, run `make docs-serve` and open [http://localhost:8000](http://localhost:8000) in your browser. diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 10cd64b..e9fef41 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -142,10 +142,10 @@ with pyspacemouse.open(device_spec=device_spec) as device: See [Custom Device Configuration](https://spacemouse.kubaandrysek.cz/mouseApi/#custom-device-configuration) for more details. ## How to write documentation -To install the required dependencies, run `pip install pyspacemouse[docs]`. +To install the required dependencies, run `make install-dev`, and please also install `doxygen` manually. Edit `README.md` only in the root folder. The documentation is automatically generated from `README.md` and `docs/` folder. -To update documentation from root to `/docs` use macro `make fixRelativeLinkDocs` which will replace all relative links from `/` to `/docs` folder. +To update documentation from root to `/docs`, use `make docs-build`. ### Building the documentation The documentation is built using [mkdocs](https://www.mkdocs.org/). To test the documentation locally, run `make docs-serve` and open [http://localhost:8000](http://localhost:8000) in your browser. diff --git a/docs/README.md b/docs/README.md index ec20409..2fa027a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -231,6 +231,8 @@ pipx install hatch==1.15.1 pre-commit If you're not familiar with pipx, it lets you install python tools into isolated environments in `~/.local`. +For building the documentation locally, you will also need `doxygen` installed and on the path. + ## Used In - [TeleMoMa](https://github.com/UT-Austin-RobIn/telemoma) - A Modular and Versatile Teleoperation System for Mobile Manipulation From 684f8a07fa6a28d48a34e120528a41f6fdda3a8a Mon Sep 17 00:00:00 2001 From: peter Date: Sun, 8 Feb 2026 19:18:46 +0100 Subject: [PATCH 2/2] fix typo and pin hatch in CI --- .github/workflows/deploy-web.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deploy-web.yaml b/.github/workflows/deploy-web.yaml index dfb28af..ef7c969 100644 --- a/.github/workflows/deploy-web.yaml +++ b/.github/workflows/deploy-web.yaml @@ -19,8 +19,8 @@ jobs: - uses: actions/setup-python@v5 with: python-version: "3.12" - - name: Install Hathch - run: pip install hatch + - name: Install Hatch + run: pip install hatch==1.15.1 - uses: actions/cache@v4 with: key: mkdocs-${{ github.ref }}