update docs

This commit is contained in:
Sina Atalay
2024-02-18 19:13:41 +01:00
parent 4178c3e5e9
commit 1653ec38db
10 changed files with 42 additions and 26 deletions

View File

@@ -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