rendercv/mkdocs.yml

85 lines
2.6 KiB
YAML
Raw Normal View History

2023-09-13 18:02:27 +00:00
site_name: "RenderCV"
2023-09-10 19:54:36 +00:00
site_description: A Python application that creates a CV in PDF from a YAML/JSON input file.
2023-09-13 17:07:22 +00:00
site_author: Sina Atalay
copyright: Copyright © 2023 Sina Atalay
2023-09-10 19:54:36 +00:00
site_url: https://sinaatalay.github.io/rendercv/
repo_url: https://github.com/sinaatalay/rendercv
2023-09-13 17:07:22 +00:00
repo_name: sinaatalay/rendercv
2023-09-10 19:54:36 +00:00
edit_uri: edit/main/docs/
2023-09-09 18:43:41 +00:00
theme:
name: material
2023-09-10 19:54:36 +00:00
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/lightbulb-outline
name: "Switch to dark mode"
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/lightbulb
name: "Switch to light mode"
2023-09-13 17:07:22 +00:00
font:
text: Roboto
code: Roboto Mono
2023-09-10 19:54:36 +00:00
features:
2023-09-13 17:07:22 +00:00
- content.code.copy # the copy-to-clipboard buttons for code blocks
- content.action.view # view source button for pages
- navigation.footer # the previous and next buttons in the footer
- navigation.indexes # allow mother pages to have their own index pages
- navigation.tabs # render classical type of navbar at top
- navigation.top # back to top button
- search.highlight # highlight search results after going to a page
- search.suggest # show search suggestions while typing
- toc.follow # if toc sidebar doesn't fit, scroll to the active heading
2023-09-09 18:43:41 +00:00
nav:
2023-09-10 19:54:36 +00:00
- Quick Start: index.md
2023-09-09 18:43:41 +00:00
- Contact: contact.md
2023-09-13 17:10:21 +00:00
- Code Documentation:
2023-10-07 21:17:54 +00:00
- Code Documentation: documentation/index.md
2023-09-13 17:10:21 +00:00
- data_model.py: documentation/data_model.md
- rendering.py: documentation/rendering.md
2023-09-09 18:43:41 +00:00
2023-09-13 18:02:27 +00:00
markdown_extensions:
# see https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/ for more pymdownx info
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.superfences
- toc:
permalink: true
title: Page contents
2023-09-09 18:43:41 +00:00
plugins:
- search
2023-09-09 18:59:39 +00:00
- mkdocstrings:
handlers:
python:
2023-09-10 19:54:36 +00:00
paths:
- rendercv
2023-09-09 18:59:39 +00:00
options:
2023-09-10 19:54:36 +00:00
members_order: source
2023-09-09 18:59:39 +00:00
show_bases: true
2023-09-10 19:54:36 +00:00
docstring_section_style: list
2023-09-13 18:02:27 +00:00
# merge_init_into_class: true
2023-09-10 19:54:36 +00:00
show_docstring_attributes: true
2023-09-13 17:07:22 +00:00
docstring_style: google
extra_javascript:
2023-09-13 18:02:27 +00:00
- javascripts/katex.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
2023-09-13 17:07:22 +00:00
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css