mirror of https://github.com/eyhc1/rendercv.git
update docs
This commit is contained in:
parent
4178c3e5e9
commit
1653ec38db
|
@ -1,3 +0,0 @@
|
||||||
# __main___
|
|
||||||
|
|
||||||
::: rendercv.__main__
|
|
|
@ -1,3 +0,0 @@
|
||||||
# Data Model
|
|
||||||
|
|
||||||
::: rendercv.data_model
|
|
|
@ -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.
|
|
|
@ -1,3 +0,0 @@
|
||||||
# Rendering
|
|
||||||
|
|
||||||
::: rendercv.rendering
|
|
|
@ -0,0 +1,3 @@
|
||||||
|
# CLI
|
||||||
|
|
||||||
|
::: rendercv.cli
|
|
@ -0,0 +1,3 @@
|
||||||
|
# Data Models
|
||||||
|
|
||||||
|
::: rendercv.data_models
|
|
@ -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.
|
|
@ -0,0 +1,3 @@
|
||||||
|
# Renderer
|
||||||
|
|
||||||
|
::: rendercv.renderer
|
|
@ -0,0 +1,15 @@
|
||||||
|
# Themes
|
||||||
|
|
||||||
|
::: rendercv.themes
|
||||||
|
|
||||||
|
## Classic Theme
|
||||||
|
|
||||||
|
::: rendercv.themes.classic
|
||||||
|
|
||||||
|
## Modercv Theme
|
||||||
|
|
||||||
|
::: rendercv.themes.moderncv
|
||||||
|
|
||||||
|
## Sb2nov Theme
|
||||||
|
|
||||||
|
::: rendercv.themes.sb2nov
|
14
mkdocs.yaml
14
mkdocs.yaml
|
@ -1,5 +1,5 @@
|
||||||
site_name: "RenderCV"
|
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
|
site_author: Sina Atalay
|
||||||
copyright: Copyright © 2023 Sina Atalay
|
copyright: Copyright © 2023 Sina Atalay
|
||||||
site_url: https://sinaatalay.github.io/rendercv/
|
site_url: https://sinaatalay.github.io/rendercv/
|
||||||
|
@ -9,6 +9,7 @@ edit_uri: edit/main/docs/
|
||||||
|
|
||||||
theme:
|
theme:
|
||||||
name: material
|
name: material
|
||||||
|
custom_dir: docs
|
||||||
palette:
|
palette:
|
||||||
- media: "(prefers-color-scheme: light)"
|
- media: "(prefers-color-scheme: light)"
|
||||||
scheme: default
|
scheme: default
|
||||||
|
@ -46,11 +47,12 @@ theme:
|
||||||
nav:
|
nav:
|
||||||
- Overview: index.md
|
- Overview: index.md
|
||||||
- User Guide: user_guide.md
|
- User Guide: user_guide.md
|
||||||
- Code Documentation:
|
- Reference:
|
||||||
- Code Documentation: code_documentation/index.md
|
- Reference: reference/index.md
|
||||||
- __main__.py: code_documentation/__main__.md
|
- cli.py: reference/cli.md
|
||||||
- data_model.py: code_documentation/data_model.md
|
- data_models.py: reference/data_models.md
|
||||||
- rendering.py: code_documentation/rendering.md
|
- renderer.py: reference/renderer.md
|
||||||
|
- themes: reference/themes.md
|
||||||
|
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
# see https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/ for more pymdownx info
|
# see https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/ for more pymdownx info
|
||||||
|
|
Loading…
Reference in New Issue