chore: Template upgrade

pawamoy · pawamoy · commit c32808889767 · 2022-05-27T21:53:16.000+02:00
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 0.9.2
+_commit: 0.9.7
 _src_path: gh:pawamoy/copier-pdm
 author_email: pawamoy@pm.me
 author_fullname: Timothée Mazzucotelli
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1,7 +1,4 @@
 github:
-  - pawamoy
-ko_fi: pawamoy
-liberapay: pawamoy
-patreon: pawamoy
+- pawamoy
 custom:
-  - https://www.paypal.me/pawamoy
+- https://www.paypal.me/pawamoy
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -105,7 +105,7 @@ jobs:
         key: tests-cache-${{ runner.os }}-${{ matrix.python-version }}
 
     - name: Install dependencies
-      run: pdm install -G duty -G docs -G tests
+      run: pdm install --no-editable -G duty -G docs -G tests
 
     - name: Run the test suite
       run: pdm run duty test
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,21 +14,21 @@ cd python-legacy
 make setup
 ```
 
-!!! note
-    If it fails for some reason,
-    you'll need to install
-    [PDM](https://github.com/pdm-project/pdm)
-    manually.
-
-    You can install it with:
-
-    ```bash
-    python3 -m pip install --user pipx
-    pipx install pdm
-    ```
-
-    Now you can try running `make setup` again,
-    or simply `pdm install`.
+> NOTE:
+> If it fails for some reason,
+> you'll need to install
+> [PDM](https://github.com/pdm-project/pdm)
+> manually.
+> 
+> You can install it with:
+> 
+> ```bash
+> python3 -m pip install --user pipx
+> pipx install pdm
+> ```
+> 
+> Now you can try running `make setup` again,
+> or simply `pdm install`.
 
 You now have the dependencies installed.
 
@@ -55,17 +55,14 @@ As usual:
 1. create a new branch: `git checkout -b feature-or-bugfix-name`
 1. edit the code and/or the documentation
 
-If you updated the documentation or the project dependencies:
-
-1. run `make docs-regen`
-1. run `make docs-serve`,
-   go to http://localhost:8000 and check that everything looks good
-
 **Before committing:**
 
 1. run `make format` to auto-format the code
 1. run `make check` to check everything (fix any warning)
 1. run `make test` to run the tests (fix any issue)
+1. if you updated the documentation or the project dependencies:
+    1. run `make docs-serve`
+    1. go to http://localhost:8000 and check that everything looks good
 1. follow our [commit message convention](#commit-message-convention)
 
 If you are unsure about how to fix or ignore a warning,
diff --git a/README.md b/README.md
@@ -8,30 +8,6 @@
 
 A legacy Python handler for mkdocstrings.
 
-## Requirements
-
-mkdocstrings-python (legacy) requires Python 3.7 or above.
-
-<details>
-<summary>To install Python 3.7, I recommend using <a href="https://github.com/pyenv/pyenv"><code>pyenv</code></a>.</summary>
-
-```bash
-# install pyenv
-git clone https://github.com/pyenv/pyenv ~/.pyenv
-
-# setup pyenv (you should also put these three lines in .bashrc or similar)
-export PATH="${HOME}/.pyenv/bin:${PATH}"
-export PYENV_ROOT="${HOME}/.pyenv"
-eval "$(pyenv init -)"
-
-# install Python 3.7
-pyenv install 3.7.12
-
-# make it available globally
-pyenv global system 3.7.12
-```
-</details>
-
 ## Installation
 
 With `pip`:
diff --git a/docs/credits.md b/docs/credits.md
@@ -0,0 +1,3 @@
+```python exec="yes"
+--8<-- "scripts/gen_credits.py"
+```
diff --git a/docs/gen_credits.py b/docs/gen_credits.py
diff --git a/docs/gen_ref_nav.py b/docs/gen_ref_nav.py
@@ -6,24 +6,25 @@
 
 nav = mkdocs_gen_files.Nav()
 
-for path in sorted(Path("src").glob("**/*.py")):
+for path in sorted(Path("src").rglob("*.py")):
     module_path = path.relative_to("src").with_suffix("")
     doc_path = path.relative_to("src").with_suffix(".md")
     full_doc_path = Path("reference", doc_path)
 
-    parts = list(module_path.parts)
+    parts = tuple(module_path.parts)
+
     if parts[-1] == "__init__":
         parts = parts[:-1]
         doc_path = doc_path.with_name("index.md")
         full_doc_path = full_doc_path.with_name("index.md")
     elif parts[-1] == "__main__":
         continue
-    nav_parts = list(parts)
-    nav[nav_parts] = doc_path
+
+    nav[parts] = doc_path.as_posix()
 
     with mkdocs_gen_files.open(full_doc_path, "w") as fd:
         ident = ".".join(parts)
-        print("::: " + ident, file=fd)
+        fd.write(f"::: {ident}")
 
     mkdocs_gen_files.set_edit_path(full_doc_path, path)
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -4,6 +4,7 @@ site_url: "https://mkdocstrings.github.io/python-legacy"
 repo_url: "https://github.com/mkdocstrings/python-legacy"
 repo_name: "mkdocstrings/python-legacy"
 site_dir: "site"
+watch: [README.md, CONTRIBUTING.md, CHANGELOG.md, src]
 
 nav:
 - Home:
@@ -26,6 +27,7 @@ theme:
     logo: material/currency-sign
   features:
   - navigation.tabs
+  - navigation.tabs.sticky
   - navigation.top
   palette:
   - media: "(prefers-color-scheme: light)"
@@ -49,6 +51,7 @@ extra_css:
 
 markdown_extensions:
 - admonition
+- callouts
 - pymdownx.emoji
 - pymdownx.magiclink
 - pymdownx.snippets:
@@ -62,22 +65,20 @@ markdown_extensions:
 
 plugins:
 - search
+- markdown-exec
 - gen-files:
     scripts:
-    - docs/gen_credits.py
     - docs/gen_ref_nav.py
 - literate-nav:
     nav_file: SUMMARY.md
-- section-index
 - coverage
+- section-index
 - mkdocstrings:
     handlers:
       python:
         paths: [src, docs]
         import:
         - https://mkdocstrings.github.io/objects.inv
-    watch:
-    - src/mkdocstrings_handlers
 
 extra:
   social:
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,15 +6,14 @@ build-backend = "pdm.pep517.api"
 name = "mkdocstrings-python-legacy"
 description = "A legacy Python handler for mkdocstrings."
 authors = [{name = "Timothée Mazzucotelli", email = "pawamoy@pm.me"}]
-license = {file = "LICENSE"}
+license-expression = "ISC"
 readme = "README.md"
 requires-python = ">=3.7"
 keywords = []
 dynamic = ["version"]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: ISC License (ISCL)",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
@@ -52,12 +51,14 @@ editable-backend = "editables"
 [tool.pdm.dev-dependencies]
 duty = ["duty>=0.7"]
 docs = [
-    "mkdocs>=1.2",
+    "mkdocs>=1.3",
     "mkdocs-coverage>=0.2",
     "mkdocs-gen-files>=0.3",
     "mkdocs-literate-nav>=0.4",
     "mkdocs-material>=7.3",
     "mkdocs-section-index>=0.3",
+    "markdown-callouts>=0.2",
+    "markdown-exec>=0.5",
     "toml>=0.10",
 ]
 format = [
@@ -66,7 +67,6 @@ format = [
     "isort>=5.10",
 ]
 maintain = [
-    # TODO: remove this section when git-changelog is more powerful
     "git-changelog>=0.4",
 ]
 quality = [
@@ -88,7 +88,6 @@ tests = [
     "pytest>=6.2",
     "pytest-cov>=3.0",
     "pytest-randomly>=3.10",
-    "pytest-sugar>=0.9",
     "pytest-xdist>=2.4",
 ]
 typing = [
diff --git a/scripts/gen_credits.py b/scripts/gen_credits.py
diff --git a/scripts/setup.sh b/scripts/setup.sh

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+```python exec="yes"
	`2`	`+--8<-- "scripts/gen_credits.py"`
	`3`	+```