From 6a44febecf08264a6e31a4c8c59b274c07e161c2 Mon Sep 17 00:00:00 2001 From: Sina Atalay Date: Sun, 19 May 2024 13:11:12 +0300 Subject: [PATCH] docs: improve developer guide --- docs/developer_guide.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/developer_guide.md b/docs/developer_guide.md index bca68f8..429c0be 100644 --- a/docs/developer_guide.md +++ b/docs/developer_guide.md @@ -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.