Skip to content

Update README and .readthedocs.yaml with improved content #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DanielAvdar merged 1 commit into from
Apr 10, 2025
Merged

Update README and .readthedocs.yaml with improved content #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ build:
jobs:
post_install:
- pip install uv
- UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --all-extras --group docs --link-mode=copy
- UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --all-extras --all-groups --link-mode=copy
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,14 @@
template python package repo for open source
[//]: # todo replace python-temp late with your package name
[//]: # todo replace DanielAvdar with your github username
# This is a template for creating a Python package repository for open source projects.

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/python-template)](https://pypi.org/project/python-template/)
[![version](https://img.shields.io/pypi/v/python-template)](https://img.shields.io/pypi/v/python-template)
[![License](https://img.shields.io/:license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
![OS](https://img.shields.io/badge/ubuntu-blue?logo=ubuntu)
![OS](https://img.shields.io/badge/win-blue?logo=windows)
![OS](https://img.shields.io/badge/mac-blue?logo=apple)
[![Tests](https://github.com/DanielAvdar/python-template/actions/workflows/ci.yml/badge.svg)](https://github.com/DanielAvdar/python-template/actions/workflows/ci.yml)
[![Code Checks](https://github.com/DanielAvdar/python-template/actions/workflows/code-checks.yml/badge.svg)](https://github.com/DanielAvdar/python-template/actions/workflows/code-checks.yml)
[![codecov](https://codecov.io/gh/DanielAvdar/python-template/graph/badge.svg?token=N0V9KANTG2)](https://codecov.io/gh/DanielAvdar/python-template)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)