From 663ced0492295fdc34eb82c7455796ac30720fce Mon Sep 17 00:00:00 2001 From: Sina Atalay <79940989+sinaatalay@users.noreply.github.com> Date: Fri, 20 Mar 2026 03:45:08 +0300 Subject: [PATCH] Refactor docs folder structure --- README.md | 6 +++--- docs/assets/images/{ => examples}/classic.png | Bin .../images/{ => examples}/engineeringclassic.png | Bin .../images/{ => examples}/engineeringresumes.png | Bin docs/assets/images/{ => examples}/harvard.png | Bin docs/assets/images/{ => examples}/moderncv.png | Bin docs/assets/images/{ => examples}/sb2nov.png | Bin docs/index.md | 6 +++--- scripts/update_examples.py | 2 +- 9 files changed, 7 insertions(+), 7 deletions(-) rename docs/assets/images/{ => examples}/classic.png (100%) rename docs/assets/images/{ => examples}/engineeringclassic.png (100%) rename docs/assets/images/{ => examples}/engineeringresumes.png (100%) rename docs/assets/images/{ => examples}/harvard.png (100%) rename docs/assets/images/{ => examples}/moderncv.png (100%) rename docs/assets/images/{ => examples}/sb2nov.png (100%) diff --git a/README.md b/README.md index 6f0bf7ec..1c3eb89d 100644 --- a/README.md +++ b/README.md @@ -60,9 +60,9 @@ cv: becomes one of these PDFs. Click on the images to preview. -| [![Classic Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/classic.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_ClassicTheme_CV.pdf) | [![Engineeringresumes Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/engineeringresumes.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_EngineeringresumesTheme_CV.pdf) | [![Sb2nov Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/sb2nov.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_Sb2novTheme_CV.pdf) | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [![Moderncv Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/moderncv.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_ModerncvTheme_CV.pdf) | [![Engineeringclassic Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/engineeringclassic.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_EngineeringclassicTheme_CV.pdf) | ![Custom themes can be added.](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/customtheme.png) | +| [![Classic Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/examples/classic.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_ClassicTheme_CV.pdf) | [![Engineeringresumes Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/examples/engineeringresumes.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_EngineeringresumesTheme_CV.pdf) | [![Sb2nov Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/examples/sb2nov.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_Sb2novTheme_CV.pdf) | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [![Moderncv Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/examples/moderncv.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_ModerncvTheme_CV.pdf) | [![Engineeringclassic Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/examples/engineeringclassic.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_EngineeringclassicTheme_CV.pdf) | [![Harvard Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/examples/harvard.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_HarvardTheme_CV.pdf) | ## JSON Schema diff --git a/docs/assets/images/classic.png b/docs/assets/images/examples/classic.png similarity index 100% rename from docs/assets/images/classic.png rename to docs/assets/images/examples/classic.png diff --git a/docs/assets/images/engineeringclassic.png b/docs/assets/images/examples/engineeringclassic.png similarity index 100% rename from docs/assets/images/engineeringclassic.png rename to docs/assets/images/examples/engineeringclassic.png diff --git a/docs/assets/images/engineeringresumes.png b/docs/assets/images/examples/engineeringresumes.png similarity index 100% rename from docs/assets/images/engineeringresumes.png rename to docs/assets/images/examples/engineeringresumes.png diff --git a/docs/assets/images/harvard.png b/docs/assets/images/examples/harvard.png similarity index 100% rename from docs/assets/images/harvard.png rename to docs/assets/images/examples/harvard.png diff --git a/docs/assets/images/moderncv.png b/docs/assets/images/examples/moderncv.png similarity index 100% rename from docs/assets/images/moderncv.png rename to docs/assets/images/examples/moderncv.png diff --git a/docs/assets/images/sb2nov.png b/docs/assets/images/examples/sb2nov.png similarity index 100% rename from docs/assets/images/sb2nov.png rename to docs/assets/images/examples/sb2nov.png diff --git a/docs/index.md b/docs/index.md index 11777b70..53da54bf 100644 --- a/docs/index.md +++ b/docs/index.md @@ -59,9 +59,9 @@ cv: becomes one of these PDFs. Click on the images to preview. -| [![Classic Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/classic.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_ClassicTheme_CV.pdf) | [![Engineeringresumes Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/engineeringresumes.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_EngineeringresumesTheme_CV.pdf) | [![Sb2nov Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/sb2nov.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_Sb2novTheme_CV.pdf) | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [![Moderncv Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/moderncv.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_ModerncvTheme_CV.pdf) | [![Engineeringclassic Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/engineeringclassic.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_EngineeringclassicTheme_CV.pdf) | ![Custom themes can be added.](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/customtheme.png) | +| [![Classic Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/examples/classic.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_ClassicTheme_CV.pdf) | [![Engineeringresumes Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/examples/engineeringresumes.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_EngineeringresumesTheme_CV.pdf) | [![Sb2nov Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/examples/sb2nov.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_Sb2novTheme_CV.pdf) | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [![Moderncv Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/examples/moderncv.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_ModerncvTheme_CV.pdf) | [![Engineeringclassic Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/examples/engineeringclassic.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_EngineeringclassicTheme_CV.pdf) | [![Harvard Theme Example of RenderCV](https://raw.githubusercontent.com/rendercv/rendercv/main/docs/assets/images/examples/harvard.png)](https://github.com/rendercv/rendercv/blob/main/examples/John_Doe_HarvardTheme_CV.pdf) | ## JSON Schema diff --git a/scripts/update_examples.py b/scripts/update_examples.py index a231b99f..2230c1b7 100644 --- a/scripts/update_examples.py +++ b/scripts/update_examples.py @@ -9,7 +9,7 @@ from rendercv.schema.sample_generator import create_sample_yaml_input_file repository_root = pathlib.Path(__file__).parent.parent rendercv_path = repository_root / "rendercv" -image_assets_directory = repository_root / "docs" / "assets" / "images" +image_assets_directory = repository_root / "docs" / "assets" / "images" / "examples" examples_directory_path = pathlib.Path(__file__).parent.parent / "examples"