mkdocs-rsoxs

A mkdocs theme for als rsoxs projects

Features

• Fast and modern Python toolchain using Astral's tools (uv, ruff, ty)
• Type-safe with full type annotations
• Comprehensive documentation with MkDocs — View Docs

Installation

pip install mkdocs_rsoxs

Or using uv (recommended):

uv add mkdocs_rsoxs

Quick Start

import mkdocs_rsoxs

print(mkdocs_rsoxs.__version__)

Development

Prerequisites

• Python 3.13+
• uv for package management

Setup

git clone https://github.com/als-rsoxs/mkdocs-rsoxs.git
cd mkdocs-rsoxs
make install

Running Tests

make test

# With coverage
make test-cov

# Across all Python versions
make test-matrix

Code Quality

# Run all checks (lint, format, type-check)
make verify

# Auto-fix lint and format issues
make fix

Prek

prek install
prek run --all-files

Documentation

The rsoxs MkDocs theme ships default ALS header icons and favicon under src/mkdocs_rsoxs/img/. Rebuild CSS with bun run build (or make docs-assets) when you change Tailwind sources.

In your mkdocs.yml, add the theme’s Jinja plugin so filters such as file_exists resolve theme static files:

plugins:
  - rsoxs
  - search

make docs-serve

Dependency Updates

This project uses Renovate to keep dependencies up to date automatically. Renovate will open pull requests when new versions of dependencies are available.

To enable it, install the Renovate GitHub App and grant it access to this repository.

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.