-
-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
37 changed files
with
706 additions
and
499 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,12 @@ | ||
# Changes here will be overwritten by Copier | ||
_commit: 1.2.6 | ||
_src_path: gh:pawamoy/copier-pdm | ||
author_email: [email protected] | ||
_commit: 1.4.1 | ||
_src_path: gh:pawamoy/copier-uv | ||
author_email: [email protected] | ||
author_fullname: Timothée Mazzucotelli | ||
author_username: pawamoy | ||
copyright_date: '2020' | ||
copyright_holder: Timothée Mazzucotelli | ||
copyright_holder_email: [email protected] | ||
copyright_holder_email: [email protected] | ||
copyright_license: ISC License | ||
insiders: false | ||
project_description: Load Python objects documentation. | ||
|
@@ -15,6 +15,6 @@ python_package_command_line_name: pytkdocs | |
python_package_distribution_name: pytkdocs | ||
python_package_import_name: pytkdocs | ||
repository_name: pytkdocs | ||
repository_namespace: pawamoy | ||
repository_namespace: mkdocstrings | ||
repository_provider: github.com | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
PATH_add scripts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
github: pawamoy | ||
ko_fi: pawamoy | ||
polar: pawamoy | ||
custom: | ||
- https://www.paypal.me/pawamoy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
name: Documentation update | ||
about: Point at unclear, missing or outdated documentation. | ||
title: "docs: " | ||
labels: docs | ||
assignees: pawamoy | ||
--- | ||
|
||
### Is something unclear, missing or outdated in our documentation? | ||
<!-- A clear and concise description of what the documentation issue is. Ex. I can't find an explanation on feature [...]. --> | ||
|
||
### Relevant code snippets | ||
<!-- If the documentation issue is related to code, please provide relevant code snippets. --> | ||
|
||
### Link to the relevant documentation section | ||
<!-- Add a link to the relevant section of our documentation, or any addition context. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
name: Change request | ||
about: Suggest any other kind of change for this project. | ||
title: "change: " | ||
assignees: pawamoy | ||
--- | ||
|
||
### Is your change request related to a problem? Please describe. | ||
<!-- A clear and concise description of what the problem is. --> | ||
|
||
### Describe the solution you'd like | ||
<!-- A clear and concise description of what you want to happen. --> | ||
|
||
### Describe alternatives you've considered | ||
<!-- A clear and concise description of any alternative solutions you've considered. --> | ||
|
||
### Additional context | ||
<!-- Add any other context or screenshots about the change request here. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: I have a question / I need help | ||
url: https://github.com/pawamoy/pytkdocs/discussions/new?category=q-a | ||
url: https://github.com/mkdocstrings/pytkdocs/discussions/new?category=q-a | ||
about: Ask and answer questions in the Discussions tab. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,25 @@ | ||
# editors | ||
.idea/ | ||
.vscode/ | ||
__pycache__/ | ||
*.py[cod] | ||
dist/ | ||
|
||
# python | ||
*.egg-info/ | ||
build/ | ||
htmlcov/ | ||
*.py[cod] | ||
.venv/ | ||
.venvs/ | ||
/build/ | ||
/dist/ | ||
|
||
# tools | ||
.coverage* | ||
pip-wheel-metadata/ | ||
/.pdm-build/ | ||
/htmlcov/ | ||
/site/ | ||
uv.lock | ||
|
||
# cache | ||
.cache/ | ||
.pytest_cache/ | ||
.mypy_cache/ | ||
site/ | ||
pdm.lock | ||
pdm.toml | ||
.pdm-plugins/ | ||
.pdm-python | ||
__pypackages__/ | ||
.venv/ | ||
.cache/ | ||
.ruff_cache/ | ||
__pycache__/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -60,7 +60,7 @@ representative at an online or offline event. | |
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the community leaders responsible for enforcement at | ||
[email protected]. | ||
[email protected]. | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,54 +1,28 @@ | ||
.DEFAULT_GOAL := help | ||
SHELL := bash | ||
DUTY := $(if $(VIRTUAL_ENV),,pdm run) duty | ||
export PDM_MULTIRUN_VERSIONS ?= 3.8 3.9 3.10 3.11 3.12 | ||
export PDM_MULTIRUN_USE_VENVS ?= $(if $(shell pdm config python.use_venv | grep True),1,0) | ||
# If you have `direnv` loaded in your shell, and allow it in the repository, | ||
# the `make` command will point at the `scripts/make` shell script. | ||
# This Makefile is just here to allow auto-completion in the terminal. | ||
|
||
args = $(foreach a,$($(subst -,_,$1)_args),$(if $(value $a),$a="$($a)")) | ||
check_quality_args = files | ||
docs_args = host port | ||
release_args = version | ||
test_args = match | ||
|
||
BASIC_DUTIES = \ | ||
actions = \ | ||
allrun \ | ||
changelog \ | ||
check \ | ||
check-api \ | ||
check-dependencies \ | ||
check-docs \ | ||
check-quality \ | ||
check-types \ | ||
clean \ | ||
coverage \ | ||
docs \ | ||
docs-deploy \ | ||
format \ | ||
help \ | ||
multirun \ | ||
release \ | ||
run \ | ||
setup \ | ||
test \ | ||
vscode | ||
|
||
QUALITY_DUTIES = \ | ||
check-quality \ | ||
check-docs \ | ||
check-types \ | ||
test | ||
|
||
.PHONY: help | ||
help: | ||
@$(DUTY) --list | ||
|
||
.PHONY: lock | ||
lock: | ||
@pdm lock -G:all | ||
|
||
.PHONY: setup | ||
setup: | ||
@bash scripts/setup.sh | ||
|
||
.PHONY: check | ||
check: | ||
@pdm multirun duty check-quality check-types check-docs | ||
@$(DUTY) check-dependencies check-api | ||
|
||
.PHONY: $(BASIC_DUTIES) | ||
$(BASIC_DUTIES): | ||
@$(DUTY) $@ $(call args,$@) | ||
|
||
.PHONY: $(QUALITY_DUTIES) | ||
$(QUALITY_DUTIES): | ||
@pdm multirun duty $@ $(call args,$@) | ||
.PHONY: $(actions) | ||
$(actions): | ||
@python scripts/make "$@" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.