eyhc
/
rendercv
mirror of https://github.com/eyhc1/rendercv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update documentation links

This commit is contained in:
Sina Atalay 2024-05-05 13:51:42 +03:00
parent 5763b58b71
commit fa50197015
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -2,7 +2,7 @@
[![test](https://github.com/sinaatalay/rendercv/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/sinaatalay/rendercv/actions/workflows/test.yaml)
[![coverage](https://coverage-badge.samuelcolvin.workers.dev/sinaatalay/rendercv.svg)](https://coverage-badge.samuelcolvin.workers.dev/redirect/sinaatalay/rendercv)
[![docs](https://img.shields.io/badge/docs-mkdocs-rgb(0%2C79%2C144))](https://sinaatalay.github.io/rendercv/)
[![docs](https://img.shields.io/badge/docs-mkdocs-rgb(0%2C79%2C144))](https://docs.rendercv.com)
[![pypi-version](https://img.shields.io/pypi/v/rendercv?label=PyPI%20version&color=rgb(0%2C79%2C144))](https://pypi.python.org/pypi/rendercv)
[![pypi-downloads](https://img.shields.io/pepy/dt/rendercv?label=PyPI%20downloads&color=rgb(0%2C%2079%2C%20144))](https://pypistats.org/packages/rendercv)
@ -79,7 +79,7 @@ RenderCV also validates the input file, and if there are any problems, it tells
rendercv render Full_Name_CV.yaml
```
You can find a comprehensive user guide that covers the data model (YAML structure) and adding custom themes in greater detail [here](https://sinaatalay.github.io/rendercv/user_guide).
You can find a comprehensive user guide that covers the data model (YAML structure) and adding custom themes in greater detail [here](https://docs.rendercv.comuser_guide).
## Motivation
@ -113,11 +113,11 @@ If you do it for RenderCV once, you may not have to do it again for a long time.
The source code of RenderCV is well-commented and documented. Reading the source code might be fun as the software structure is explained with docstrings and comments.
A detailed user guide can be found [here](https://sinaatalay.github.io/rendercv/user_guide).
A detailed user guide can be found [here](https://docs.rendercv.comuser_guide).
Reference to the code can be found [here](https://sinaatalay.github.io/rendercv/reference).
Reference to the code can be found [here](https://docs.rendercv.comreference).
The changelog can be found [here](https://sinaatalay.github.io/rendercv/changelog).
The changelog can be found [here](https://docs.rendercv.comchangelog).
## Contributing

2
mkdocs.yaml
View File

@ -2,7 +2,7 @@ site_name: RenderCV
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/
site_url: https://docs.rendercv.com
repo_url: https://github.com/sinaatalay/rendercv
repo_name: sinaatalay/rendercv
edit_uri: edit/main/docs/

2
pyproject.toml
View File

@ -82,7 +82,7 @@ classifiers = [
[project.urls]
# Here, we can specify the URLs related to RenderCV. They will be listed under the
# "Project links" section in PyPI. See https://pypi.org/project/rendercv/
Documentation = 'https://sinaatalay.github.io/rendercv/'
Documentation = 'https://docs.rendercv.com'
Source = 'https://github.com/sinaatalay/rendercv'
[project.scripts]

2
rendercv/cli.py
View File

@ -50,7 +50,7 @@ def welcome():
table.add_column("Title", style="magenta")
table.add_column("Link", style="cyan", justify="right", no_wrap=True)
table.add_row("Documentation", "https://sinaatalay.github.io/rendercv/")
table.add_row("Documentation", "https://docs.rendercv.com")
table.add_row("Source code", "https://github.com/sinaatalay/rendercv/")
table.add_row("Bug reports", "https://github.com/sinaatalay/rendercv/issues/")
table.add_row("Feature requests", "https://github.com/sinaatalay/rendercv/issues/")