Skip to content

Commit 1b6b778

Browse files
authored
chore: use uv to handle dependencies (#260)
1 parent bdb1d4a commit 1b6b778

File tree

5 files changed

+319
-20
lines changed

5 files changed

+319
-20
lines changed

.github/workflows/publish.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
workflow_dispatch:
55
push:
66
tags:
7-
- '*'
7+
- "*"
88

99
jobs:
1010
publish:
@@ -13,10 +13,14 @@ jobs:
1313
- uses: actions/checkout@v5
1414
- uses: actions/setup-python@v6
1515
with:
16-
python-version: '3.11'
16+
python-version-file: "pyproject.toml"
1717

18-
- run: pip install -r requirements.txt
19-
- run: sphinx-build docs/standard build -c .
18+
- uses: astral-sh/setup-uv@v6
19+
with:
20+
version: "0.9.7"
21+
enable-cache: true
22+
23+
- run: uv run sphinx-build docs/standard build -c .
2024
- run: echo yml.publiccode.tools > build/CNAME
2125

2226
- name: Publish on GitHub Pages

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -109,28 +109,24 @@ This project follows the [Semantic Versioning](https://semver.org/).
109109
## Contributing
110110

111111
Feel free to submit [Pull Requests, file Issues](CONTRIBUTING.md) or open
112-
a [Discussion](https://github.com/publiccodeyml/publiccode.yml/discussions).
112+
a [Discussion](https://github.com/publiccodeyml/publiccode.yml/discussions).
113113

114114
The [Standard's website](https://yml.publiccode.tools) is built using the Python
115115
Sphinx package and
116116
[deployed](https://github.com/publiccodeyml/publiccode.yml/blob/main/.github/workflows/publish.yml)
117117
on GitHub Pages.
118118

119119
### Prerequisites
120-
- Python 3.11
121120

122-
### Install dependencies
123-
124-
```console
125-
pip install -r requirements.txt
126-
```
121+
- [`uv`](https://docs.astral.sh/uv/getting-started/installation/)
127122

128123
### Local development process
124+
129125
`sphinx-build` can be used to compile all source file to static html files. Run
130126
this command to generate the website:
131127

132128
```console
133-
sphinx-build docs/standard build -c .
129+
uv run sphinx-build docs/standard build -c .
134130
```
135131

136132
then open the relevant file in the build directory with a browser (e.g.,

pyproject.toml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[project]
2+
name = "publiccode-yml"
3+
version = "0.5.0"
4+
requires-python = "==3.11.13"
5+
dependencies = [
6+
"sphinx==4.4.0",
7+
"sphinx-press-theme==0.8.0",
8+
"sphinxcontrib-applehelp==1.0.4",
9+
"sphinxcontrib-devhelp==1.0.2",
10+
"sphinxcontrib-htmlhelp==2.0.1",
11+
"sphinxcontrib-qthelp==1.0.3",
12+
"sphinxcontrib-serializinghtml==1.1.5",
13+
"urllib3==2.5.0",
14+
]

requirements.txt

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)