Skip to content

Commit db588c2

Browse files
committed
chore: Template upgrade (disable insiders)
1 parent 82f5eb9 commit db588c2

File tree

15 files changed

+28
-926
lines changed

15 files changed

+28
-926
lines changed

.copier-answers.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changes here will be overwritten by Copier
2-
_commit: 1.1.1
2+
_commit: 1.1.3
33
_src_path: gh:pawamoy/copier-pdm
44
author_email: pawamoy@pm.me
55
author_fullname: Timothée Mazzucotelli
@@ -8,11 +8,9 @@ copyright_date: '2023'
88
copyright_holder: Timothée Mazzucotelli
99
copyright_holder_email: pawamoy@pm.me
1010
copyright_license: ISC License
11-
insiders: true
12-
insiders_repository_name: griffe-inherited-docstrings
11+
insiders: false
1312
project_description: Griffe extension for inheriting docstrings.
1413
project_name: Griffe Inherited Docstrings
15-
public_release: false
1614
python_package_command_line_name: ''
1715
python_package_distribution_name: griffe-inherited-docstrings
1816
python_package_import_name: griffe_inherited_docstrings

.github/workflows/ci.yml

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -54,29 +54,8 @@ jobs:
5454
- name: Check for breaking changes in the API
5555
run: pdm run duty check-api
5656

57-
exclude-test-jobs:
58-
runs-on: ubuntu-latest
59-
outputs:
60-
jobs: ${{ steps.exclude-jobs.outputs.jobs }}
61-
steps:
62-
- id: exclude-jobs
63-
run: |
64-
if ${{ github.repository_owner == 'pawamoy-insiders' }}; then
65-
echo 'jobs=[
66-
{"os": "macos-latest"},
67-
{"os": "windows-latest"},
68-
{"python-version": "3.9"},
69-
{"python-version": "3.10"},
70-
{"python-version": "3.11"},
71-
{"python-version": "3.12"}
72-
]' | tr -d '[:space:]' >> $GITHUB_OUTPUT
73-
else
74-
echo 'jobs=[]' >> $GITHUB_OUTPUT
75-
fi
76-
7757
tests:
7858

79-
needs: exclude-test-jobs
8059
strategy:
8160
max-parallel: 4
8261
matrix:
@@ -90,7 +69,6 @@ jobs:
9069
- "3.10"
9170
- "3.11"
9271
- "3.12"
93-
exclude: ${{ fromJSON(needs.exclude-test-jobs.outputs.jobs) }}
9472
runs-on: ${{ matrix.os }}
9573
continue-on-error: ${{ matrix.python-version == '3.12' }}
9674

.github/workflows/release.yml

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,11 @@ jobs:
1515
run: git fetch --depth=1 --tags
1616
- name: Setup Python
1717
uses: actions/setup-python@v4
18-
- name: Install build
19-
if: github.repository_owner == 'pawamoy-insiders'
20-
run: python -m pip install build
21-
- name: Build dists
22-
if: github.repository_owner == 'pawamoy-insiders'
23-
run: python -m build
24-
- name: Upload dists artifact
25-
uses: actions/upload-artifact@v3
26-
if: github.repository_owner == 'pawamoy-insiders'
27-
with:
28-
name: griffe-inherited-docstrings-insiders
29-
path: ./dist/*
3018
- name: Install git-changelog
31-
if: github.repository_owner != 'pawamoy-insiders'
3219
run: pip install git-changelog
3320
- name: Prepare release notes
34-
if: github.repository_owner != 'pawamoy-insiders'
3521
run: git-changelog --release-notes > release-notes.md
36-
- name: Create release with assets
37-
uses: softprops/action-gh-release@v1
38-
if: github.repository_owner == 'pawamoy-insiders'
39-
with:
40-
files: ./dist/*
4122
- name: Create release
4223
uses: softprops/action-gh-release@v1
43-
if: github.repository_owner != 'pawamoy-insiders'
4424
with:
4525
body_path: release-notes.md

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,27 @@
11
# Griffe Inherited Docstrings
22

3+
[![ci](https://github.com/mkdocstrings/griffe-inherited-docstrings/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe-inherited-docstrings/actions?query=workflow%3Aci)
34
[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://mkdocstrings.github.io/griffe-inherited-docstrings/)
5+
[![pypi version](https://img.shields.io/pypi/v/griffe-inherited-docstrings.svg)](https://pypi.org/project/griffe-inherited-docstrings/)
46
[![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/griffe-inherited-docstrings)
5-
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://gitter.im/mkdocstrings/mkdocstrings)
7+
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#griffe-inherited-docstrings:gitter.im)
68

79
Griffe extension for inheriting docstrings.
810

911
## Installation
1012

11-
See [Insiders installation](https://mkdocstrings.github.io/mkdocstrings/insiders/installation.md).
13+
With `pip`:
14+
15+
```bash
16+
pip install griffe-inherited-docstrings
17+
```
18+
19+
With [`pipx`](https://github.com/pipxproject/pipx):
20+
21+
```bash
22+
python3.8 -m pip install --user pipx
23+
pipx install griffe-inherited-docstrings
24+
```
1225

1326
## Usage
1427

config/git-changelog.toml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
bump = "auto"
2+
convention = "angular"
3+
in-place = true
4+
output = "CHANGELOG.md"
5+
parse-refs = false
6+
parse-trailers = true
7+
sections = ["build", "deps", "feat", "fix", "refactor"]
8+
template = "keepachangelog"

docs/.overrides/main.html

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,6 @@
22

33
{% block announce %}
44

5-
<a href="{{ 'insiders/#how-to-become-a-sponsor' | url }}"><strong>Sponsorship</strong></a>
6-
is now available!
7-
<span class="twemoji heart pulse">
8-
{% include ".icons/octicons/heart-fill-16.svg" %}
9-
</span> &mdash;
10-
115
For updates follow <strong>@pawamoy</strong> on
126
<a rel="me" href="https://fosstodon.org/@pawamoy">
137
<span class="twemoji mastodon">

docs/css/insiders.css

Lines changed: 0 additions & 124 deletions
This file was deleted.

docs/insiders/changelog.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/insiders/goals.yml

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)