mirror of
https://github.com/rendercv/rendercv.git
synced 2025-12-23 21:47:55 -05:00
update docs
This commit is contained in:
@@ -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
|
||||
3
docs/reference/cli.md
Normal file
3
docs/reference/cli.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# CLI
|
||||
|
||||
::: rendercv.cli
|
||||
3
docs/reference/data_models.md
Normal file
3
docs/reference/data_models.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Data Models
|
||||
|
||||
::: rendercv.data_models
|
||||
10
docs/reference/index.md
Normal file
10
docs/reference/index.md
Normal file
@@ -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.
|
||||
3
docs/reference/renderer.md
Normal file
3
docs/reference/renderer.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Renderer
|
||||
|
||||
::: rendercv.renderer
|
||||
15
docs/reference/themes.md
Normal file
15
docs/reference/themes.md
Normal file
@@ -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_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
|
||||
|
||||
Reference in New Issue
Block a user