From 1653ec38dbf3d7b947eed671944bdb9a161c84dd Mon Sep 17 00:00:00 2001 From: Sina Atalay Date: Sun, 18 Feb 2024 19:13:41 +0100 Subject: [PATCH] update docs --- docs/code_documentation/__main__.md | 3 --- docs/code_documentation/data_model.md | 3 --- docs/code_documentation/index.md | 11 ----------- docs/code_documentation/rendering.md | 3 --- docs/reference/cli.md | 3 +++ docs/reference/data_models.md | 3 +++ docs/reference/index.md | 10 ++++++++++ docs/reference/renderer.md | 3 +++ docs/reference/themes.md | 15 +++++++++++++++ mkdocs.yaml | 14 ++++++++------ 10 files changed, 42 insertions(+), 26 deletions(-) delete mode 100644 docs/code_documentation/__main__.md delete mode 100644 docs/code_documentation/data_model.md delete mode 100644 docs/code_documentation/index.md delete mode 100644 docs/code_documentation/rendering.md create mode 100644 docs/reference/cli.md create mode 100644 docs/reference/data_models.md create mode 100644 docs/reference/index.md create mode 100644 docs/reference/renderer.md create mode 100644 docs/reference/themes.md diff --git a/docs/code_documentation/__main__.md b/docs/code_documentation/__main__.md deleted file mode 100644 index e8073f9..0000000 --- a/docs/code_documentation/__main__.md +++ /dev/null @@ -1,3 +0,0 @@ -# __main___ - -::: rendercv.__main__ \ No newline at end of file diff --git a/docs/code_documentation/data_model.md b/docs/code_documentation/data_model.md deleted file mode 100644 index 97a2927..0000000 --- a/docs/code_documentation/data_model.md +++ /dev/null @@ -1,3 +0,0 @@ -# Data Model - -::: rendercv.data_model \ No newline at end of file diff --git a/docs/code_documentation/index.md b/docs/code_documentation/index.md deleted file mode 100644 index a6e1dac..0000000 --- a/docs/code_documentation/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# RenderCV - -::: rendercv - -In this section, you can find how RenderCV works in detail. - -Modules: - -- [\_\_main\_\_](__main__.md) – This module contains the main functions of RenderCV. -- [data_model](data_model.md) – This module contains classes and functions to parse RenderCV's specifically structured YAML or JSON to generate meaningful data for Python. -- [rendering](rendering.md) – This module implements $\LaTeX$ file generation and $\LaTeX$ runner utilities for RenderCV. \ No newline at end of file diff --git a/docs/code_documentation/rendering.md b/docs/code_documentation/rendering.md deleted file mode 100644 index a3e4769..0000000 --- a/docs/code_documentation/rendering.md +++ /dev/null @@ -1,3 +0,0 @@ -# Rendering - -::: rendercv.rendering \ No newline at end of file diff --git a/docs/reference/cli.md b/docs/reference/cli.md new file mode 100644 index 0000000..28681d4 --- /dev/null +++ b/docs/reference/cli.md @@ -0,0 +1,3 @@ +# CLI + +::: rendercv.cli \ No newline at end of file diff --git a/docs/reference/data_models.md b/docs/reference/data_models.md new file mode 100644 index 0000000..d7af685 --- /dev/null +++ b/docs/reference/data_models.md @@ -0,0 +1,3 @@ +# Data Models + +::: rendercv.data_models \ No newline at end of file diff --git a/docs/reference/index.md b/docs/reference/index.md new file mode 100644 index 0000000..80e745d --- /dev/null +++ b/docs/reference/index.md @@ -0,0 +1,10 @@ +# RenderCV + +::: rendercv + +In this section, you can find how RenderCV's components are structured and how they interact with each other. + +- [cli.py](cli.md) – This module contains all the command-line interface (CLI) related code for RenderCV. +- [data_models.py](data_models.md) – This module contains classes and functions to parse and validate RenderCV's input YAML. +- [renderer.py](renderer.md) – This module implements $\LaTeX$ file generation and $\LaTeX$ runner utilities for RenderCV. +- [themes](themes.md) – This package contains all the built-in themes of RenderCV. diff --git a/docs/reference/renderer.md b/docs/reference/renderer.md new file mode 100644 index 0000000..f93bbf1 --- /dev/null +++ b/docs/reference/renderer.md @@ -0,0 +1,3 @@ +# Renderer + +::: rendercv.renderer \ No newline at end of file diff --git a/docs/reference/themes.md b/docs/reference/themes.md new file mode 100644 index 0000000..a33f9ab --- /dev/null +++ b/docs/reference/themes.md @@ -0,0 +1,15 @@ +# Themes + +::: rendercv.themes + +## Classic Theme + +::: rendercv.themes.classic + +## Modercv Theme + +::: rendercv.themes.moderncv + +## Sb2nov Theme + +::: rendercv.themes.sb2nov \ No newline at end of file diff --git a/mkdocs.yaml b/mkdocs.yaml index 701cbf0..4e64713 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -1,5 +1,5 @@ site_name: "RenderCV" -site_description: A Python application that creates a CV in PDF from a YAML/JSON input file. +site_description: LaTeX CV generator engine from a YAML input file. site_author: Sina Atalay copyright: Copyright © 2023 Sina Atalay site_url: https://sinaatalay.github.io/rendercv/ @@ -9,6 +9,7 @@ edit_uri: edit/main/docs/ theme: name: material + custom_dir: docs palette: - media: "(prefers-color-scheme: light)" scheme: default @@ -46,11 +47,12 @@ theme: nav: - Overview: index.md - User Guide: user_guide.md - - Code Documentation: - - Code Documentation: code_documentation/index.md - - __main__.py: code_documentation/__main__.md - - data_model.py: code_documentation/data_model.md - - rendering.py: code_documentation/rendering.md + - Reference: + - Reference: reference/index.md + - cli.py: reference/cli.md + - data_models.py: reference/data_models.md + - renderer.py: reference/renderer.md + - themes: reference/themes.md markdown_extensions: # see https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/ for more pymdownx info