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
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- uses: actions/checkout@v5
- uses: actions/setup-python@v6
with:
python-version: '3.9'
python-version: '3.11'

- run: pip install -r requirements.txt
- run: sphinx-build docs/standard build -c .
Expand Down
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,17 +106,20 @@ searching using the frontend or the API.

**Latest release:** [![GitHub release](https://img.shields.io/github/release/publiccodeyml/publiccode.yml.svg?style=plastic)](https://github.com/publiccodeyml/publiccode.yml/releases) [See all versions](https://github.com/publiccodeyml/publiccode.yml/releases)

This project follows the Semantic Versioning. For more information see
[SemVer.org](https://semver.org/).
This project follows the [Semantic Versioning](https://semver.org/).

## Contributing

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

The Standard's website (https://yml.publiccode.tools) is built using the Python Sphinx package.
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.9
- Python 3.11

### Install dependencies

Expand All @@ -125,12 +128,16 @@ pip install -r requirements.txt
```

### Local development process
`spinx-build` can be used to compile all source file to static html files. Run this command to generate the website:
`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 .
```

## Licence
then open the relevant file in the build directory with a browser (e.g.,
`build/index.html`) to explore the contents.

Licenced under the [CC0-1.0](LICENSE).
## License

Licensed under the [CC0-1.0](LICENSE).
2 changes: 1 addition & 1 deletion docs/standard/example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Minimum Version


Extended Version
~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~

.. literalinclude:: example/publiccode.yml
:language: yaml
Expand Down