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
12 changes: 8 additions & 4 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
workflow_dispatch:
push:
tags:
- '*'
- "*"

jobs:
publish:
Expand All @@ -13,10 +13,14 @@ jobs:
- uses: actions/checkout@v5
- uses: actions/setup-python@v6
with:
python-version: '3.11'
python-version-file: "pyproject.toml"

- run: pip install -r requirements.txt
- run: sphinx-build docs/standard build -c .
- uses: astral-sh/setup-uv@v6
with:
version: "0.9.7"
enable-cache: true

- run: uv run sphinx-build docs/standard build -c .
- run: echo yml.publiccode.tools > build/CNAME

- name: Publish on GitHub Pages
Expand Down
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,28 +109,24 @@ This project follows the [Semantic Versioning](https://semver.org/).
## Contributing

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

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

### Prerequisites
- Python 3.11

### Install dependencies

```console
pip install -r requirements.txt
```
- [`uv`](https://docs.astral.sh/uv/getting-started/installation/)

### Local development process

`sphinx-build` can be used to compile all source file to static html files. Run
this command to generate the website:

```console
sphinx-build docs/standard build -c .
uv run sphinx-build docs/standard build -c .
```

then open the relevant file in the build directory with a browser (e.g.,
Expand Down
14 changes: 14 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[project]
name = "publiccode-yml"
version = "0.5.0"
requires-python = "==3.11.13"
dependencies = [
"sphinx==4.4.0",
"sphinx-press-theme==0.8.0",
"sphinxcontrib-applehelp==1.0.4",
"sphinxcontrib-devhelp==1.0.2",
"sphinxcontrib-htmlhelp==2.0.1",
"sphinxcontrib-qthelp==1.0.3",
"sphinxcontrib-serializinghtml==1.1.5",
"urllib3==2.5.0",
]
8 changes: 0 additions & 8 deletions requirements.txt

This file was deleted.

Loading