eyhc
/
rendercv
mirror of https://github.com/eyhc1/rendercv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: improve developer guide

This commit is contained in:
Sina Atalay 2024-05-19 13:11:12 +03:00
parent 077246c097
commit 6a44febecf
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/developer_guide.md
View File

@ -34,7 +34,7 @@ python -m venv .venv
6. Install the dependencies.
```bash
pip install .[docs,tests,dev]
pip install --editable .[docs,tests,dev]
```
## How RenderCV works?
@ -62,6 +62,14 @@ The documentation's source files are located in the `docs` directory and it is b
mkdocs serve
```
### Updating the examples and the JSON Schema
The example entry images found in the [Structure of the YAML input file](user_guide/structure_of_the_yaml_input_file.md), the `examples` folder, and the JSON Schema `schema.json` are generated using the script `docs/update_rendercv_files.py`. To update these files, run `update_rendercv_files.py` with the following command.
```bash
python docs/update_rendercv_files.py
```
## Testing
After updating the code, all tests should pass. To run the tests, use the following command.