diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 7731dedf..b4ba9c39 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -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 . diff --git a/README.md b/README.md index 7981a0eb..de516902 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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). diff --git a/docs/standard/example.rst b/docs/standard/example.rst index a8612de3..96330756 100644 --- a/docs/standard/example.rst +++ b/docs/standard/example.rst @@ -14,7 +14,7 @@ Minimum Version Extended Version -~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~ .. literalinclude:: example/publiccode.yml :language: yaml