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
17 changes: 17 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: CI
on:
pull_request:
jobs:
docs:
name: docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- name: Install uv
uses: astral-sh/setup-uv@v6
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version-file: ".python-version"
- name: Build docs
run: uv run sphinx-build -b html . _build/html
21 changes: 9 additions & 12 deletions .github/workflows/gh_pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,15 @@ jobs:
name: Build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Install graphviz
run: sudo apt-get --yes install graphviz
- uses: eifinger/setup-rye@v4
- run: rye sync
# TODO locally rye sync appears to correctly run maturin internally,
# but on the CI intermitently fails to build the extension
- name: Run documentation build
run: rye run sphinx-build -a -E -b html . _build/html
- uses: actions/checkout@v5
- name: Install uv
uses: astral-sh/setup-uv@v6
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version-file: ".python-version"
- name: Build docs
run: uv run sphinx-build -b html . _build/html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ wheels/

# venv
.venv
.python-version
_build
.report.json
.vscode
Expand Down
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.12.7
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ the MIT License.
## Installation

1. Check out repo
2. Use `rye` for manageing the Python venv
3. Install Python dependencies: `rye sync`
4. Build docs via: `rye run sphinx-build -a -E -b html . _build/html`
2. Use `uv` for manageing the Python venv
3. Install Python dependencies: `uv sync`
4. Build docs via: `uv run sphinx-build -a -E -b html . _build/html`
5. Open any browser, for instance via `firefox _build/html/index.html`

## Usage
Expand Down
6 changes: 1 addition & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ authors = [
]
dependencies = [
"sphinx[test]>=8.2.3",
"sphinx-needs[plotting]>=5.1.0",
"sphinx-needs[plotting]>=6.1.0",
"sphinxcontrib-plantuml>=0.30",
"sphinx-design>=0.6.1",
"sphinx-simplepdf>=1.6.0",
Expand All @@ -20,10 +20,6 @@ requires-python = ">= 3.11"
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.rye]
managed = true
dev-dependencies = []

[tool.hatch.metadata]
allow-direct-references = true

Expand Down
179 changes: 0 additions & 179 deletions requirements-dev.lock

This file was deleted.

Loading