Skip to content

Commit cb06c62

Browse files
tomootesbfabio
authored andcommitted
docs: add simple explanation on how to develop locally
1 parent bffe276 commit cb06c62

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,24 @@ Furthermore, the project uses branches and tags in the following way:
8787

8888
Feel free to submit [Pull Requests and to file Issues](CONTRIBUTING.md).
8989

90+
The Standard's website (https://yml.publiccode.tools) is built using the Python Sphinx package.
91+
92+
### Prerequisites
93+
- Python 3
94+
95+
### Install dependencies
96+
97+
```console
98+
pip install -r requirements.txt
99+
```
100+
101+
### Local development process
102+
`spinx-build` can be used to compile all source file to static html files. Run this command to generate the website:
103+
104+
```console
105+
sphinx-build docs/standard build -c .
106+
```
107+
90108
## Licence
91109

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

0 commit comments

Comments
 (0)