Skip to content

Commit

Permalink
chore: Template upgrade
Browse files Browse the repository at this point in the history
  • Loading branch information
pawamoy committed Aug 6, 2023
1 parent c5efc65 commit 8410593
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .copier-answers.yml
@@ -1,5 +1,5 @@
# Changes here will be overwritten by Copier
_commit: 0.16.2
_commit: 0.16.5
_src_path: gh:pawamoy/copier-pdm
author_email: pawamoy@pm.me
author_fullname: Timothée Mazzucotelli
Expand Down
2 changes: 1 addition & 1 deletion Makefile
@@ -1,7 +1,7 @@
.DEFAULT_GOAL := help
SHELL := bash
DUTY := $(if $(VIRTUAL_ENV),,pdm run) duty
export PDM_MULTIRUN_VERSIONS ?= 3.8 3.9 3.10 3.11
export PDM_MULTIRUN_VERSIONS ?= 3.8 3.9 3.10 3.11 3.12

args = $(foreach a,$($(subst -,_,$1)_args),$(if $(value $a),$a="$($a)"))
check_quality_args = files
Expand Down
2 changes: 1 addition & 1 deletion docs/insiders/index.md
Expand Up @@ -220,7 +220,7 @@ by the [ISC License][license]. However, we kindly ask you to respect our
[goals completed]: #goals-completed
[github sponsor profile]: https://github.com/sponsors/pawamoy
[billing cycle]: https://docs.github.com/en/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle
[license]: ../license/
[license]: ../license.md
[private forks]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository

<script src="../js/insiders.js"></script>
Expand Down
12 changes: 11 additions & 1 deletion docs/insiders/installation.md
Expand Up @@ -13,6 +13,16 @@ you need to [become an eligible sponsor] of @pawamoy on GitHub.

## Installation

### with PyPI Insiders

[PyPI Insiders](https://pawamoy.github.io/pypi-insiders/)
is a tool that helps you keep up-to-date versions
of Insiders projects in the PyPI index of your choice
(self-hosted, Google registry, Artifactory, etc.).

See [how to install it](https://pawamoy.github.io/pypi-insiders/#installation)
and [how to use it](https://pawamoy.github.io/pypi-insiders/#usage).

### with pip (ssh/https)

*mkdocstrings-python Insiders* can be installed with `pip` [using SSH][using ssh]:
Expand Down Expand Up @@ -97,7 +107,7 @@ or installing a package (with pip), and depending on the registry you are using
Please check the documentation of your registry to learn how to configure your environment.

**We kindly ask that you do not upload the distributions to public registries,
as it is against our [Terms of use](../#terms).**
as it is against our [Terms of use](index.md#terms).**

>? TIP: **Full example with `pypiserver`**
> In this example we use [pypiserver] to serve a local PyPI index.
Expand Down
6 changes: 3 additions & 3 deletions duties.py
Expand Up @@ -53,10 +53,10 @@ def merge(d1: Any, d2: Any) -> Any: # noqa: D103


def mkdocs_config() -> str: # noqa: D103
from mkdocs import utils
import mergedeep

# patch YAML loader to merge arrays
utils.merge = merge
# force YAML loader to merge arrays
mergedeep.merge = merge

if "+insiders" in pkgversion("mkdocs-material"):
return "mkdocs.insiders.yml"
Expand Down
6 changes: 6 additions & 0 deletions mkdocs.yml
Expand Up @@ -6,6 +6,12 @@ repo_name: "mkdocstrings/python"
site_dir: "site"
watch: [mkdocs.yml, README.md, CONTRIBUTING.md, CHANGELOG.md, src/mkdocstrings_handlers]
copyright: Copyright &copy; 2021 Timothée Mazzucotelli
edit_uri: edit/main/docs/

validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn

nav:
- Home:
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Expand Up @@ -21,6 +21,7 @@ classifiers = [
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Topic :: Documentation",
"Topic :: Software Development",
"Topic :: Software Development :: Documentation",
Expand Down Expand Up @@ -61,7 +62,7 @@ docs = [
"black>=23.1",
"markdown-callouts>=0.2",
"markdown-exec>=0.5",
"mkdocs>=1.3",
"mkdocs>=1.5",
"mkdocs-coverage>=0.2",
"mkdocs-gen-files>=0.3",
"mkdocs-git-committers-plugin-2>=1.1",
Expand Down

0 comments on commit 8410593

Please sign in to comment.