Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 12 additions & 22 deletions .github/workflows/spaceros.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,21 @@ on:

jobs:
test:
runs-on: ubuntu-20.04
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@v2

- name: Setup Python
uses: actions/setup-python@v1
- uses: prefix-dev/setup-pixi@v0.9.1
with:
python-version: 3.8
pixi-version: v0.56.0
cache: true

- name: Install dependencies with pip
run: |
pip install --no-warn-script-location --user -r requirements.txt -c constraints.txt

- name: Build
run: make html
- name: Test
run: make test
- name: Build and test
run: pixi run ci

deploy:
runs-on: ubuntu-20.04
runs-on: ubuntu-24.04
permissions:
contents: write
needs: test
Expand All @@ -37,17 +31,13 @@ jobs:
- name: Checkout sources
uses: actions/checkout@v2

- name: Setup Python
uses: actions/setup-python@v1
- uses: prefix-dev/setup-pixi@v0.9.1
with:
python-version: 3.8

- name: Install dependencies with pip
run: |
pip install --no-warn-script-location --user -r requirements.txt -c constraints.txt
pixi-version: v0.56.0
cache: true

- name: Build
run: make multiversion
- name: Build multiversion docs
run: pixi run deploy

- name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@v4
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,6 @@ build/
_build/
.idea/
.vscode/

# Pixi
.pixi/
22 changes: 0 additions & 22 deletions Makefile

This file was deleted.

56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,68 @@
This repository contains the sources for the Space ROS documentation which is hosted as: https://space-ros.github.io/docs
The sources from this repository are built by GitHub Actions.

## Quick Start with Pixi

This project uses [Pixi](https://pixi.sh) for dependency management and task running. To get started:

1. **Install Pixi** (if not already installed):
Follow the installation instructions at https://pixi.sh

2. **Install dependencies**:
```bash
pixi install
```

3. **Build documentation**:
```bash
# Build single version
pixi run html

# Build multi-version (for deployment)
pixi run multiversion
```

4. **Run tests**:
```bash
pixi run test
```

5. **Serve locally** (optional):
```bash
pixi run serve
```

## Available Commands

| Command | Description |
|---------|-------------|
| `pixi run html` | Build single version documentation |
| `pixi run multiversion` | Build multi-version documentation |
| `pixi run test` | Run doc8 linting tests |
| `pixi run clean` | Clean build directory |
| `pixi run serve` | Serve documentation locally |
| `pixi run ci` | Run CI workflow (test + build) |
| `pixi run deploy` | Run deployment workflow (test + multiversion) |



## Contributing to the documentation

Contributions to this site are most welcome.
Please see the [Contributing to ROS 2 Documentation](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.html) page to learn more.
Most of the guidelines there apply but the branch structure is much simpler as Space ROS currently has only one supported distribution.

### Development Workflow

1. Fork and clone the repository
2. Install dependencies: `pixi install`
3. Make your changes to the documentation
4. Test your changes: `pixi run test`
5. Build and preview: `pixi run html && pixi run serve`
6. Submit a pull request



## Contributing to Space ROS

To contribute to the Space ROS and ROS 2 projects please refer to the [ROS 2 contributing guidelines](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing.html).
33 changes: 0 additions & 33 deletions constraints.txt

This file was deleted.

28 changes: 0 additions & 28 deletions docker/image/Dockerfile

This file was deleted.

Loading