File tree Expand file tree Collapse file tree 7 files changed +25
-18
lines changed
Expand file tree Collapse file tree 7 files changed +25
-18
lines changed Original file line number Diff line number Diff line change 11# Changes here will be overwritten by Copier
2- _commit : 0.8.1
2+ _commit : 0.9.0
33_src_path : gh:pawamoy/copier-pdm
44author_email : pawamoy@pm.me
5- author_fullname : " Timoth \xE9 e Mazzucotelli"
5+ author_fullname : Timothée Mazzucotelli
66author_username : pawamoy
77copyright_date : ' 2021'
8- copyright_holder : " Timoth \xE9 e Mazzucotelli"
8+ copyright_holder : Timothée Mazzucotelli
99copyright_holder_email : pawamoy@pm.me
1010copyright_license : ISC License
1111project_description : A Python handler for mkdocstrings.
12- project_name : Python for mkdocstrings
12+ project_name : mkdocstrings-python
1313python_package_command_line_name : mkdocstrings-python
1414python_package_distribution_name : mkdocstrings-python
15- python_package_import_name : mkdocstrings
15+ python_package_import_name : mkdocstrings_handlers
1616repository_name : python
1717repository_namespace : mkdocstrings
1818repository_provider : github.com
1919use_precommit : false
20+
Original file line number Diff line number Diff line change @@ -24,7 +24,7 @@ A clear and concise description of what you expected to happen.
2424If applicable, add screenshots to help explain your problem.
2525
2626** System (please complete the following information):**
27- - ` Python for mkdocstrings` version: [ e.g. 0.2.1]
27+ - ` mkdocstrings-python ` version: [ e.g. 0.2.1]
2828- Python version: [ e.g. 3.8]
2929- OS: [ Windows/Linux]
3030
Original file line number Diff line number Diff line change 1- # Python for mkdocstrings
1+ # mkdocstrings-python
22
33[ ![ ci] ( https://github.com/mkdocstrings/python/workflows/ci/badge.svg )] ( https://github.com/mkdocstrings/python/actions?query=workflow%3Aci )
44[ ![ documentation] ( https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat )] ( https://mkdocstrings.github.io/python/ )
@@ -13,7 +13,7 @@ A Python handler for [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings
1313
1414## Requirements
1515
16- Python for mkdocstrings requires Python 3.7 or above.
16+ mkdocstrings-python requires Python 3.7 or above.
1717
1818<details >
1919<summary >To install Python 3.7, I recommend using <a href =" https://github.com/pyenv/pyenv " ><code >pyenv</code ></a >.</summary >
Original file line number Diff line number Diff line change 1- site_name : " Python for mkdocstrings"
1+ site_name : " mkdocstrings-python "
22site_description : " A Python handler for mkdocstrings."
33site_url : " https://mkdocstrings.github.io/python"
44repo_url : " https://github.com/mkdocstrings/python"
@@ -70,12 +70,6 @@ plugins:
7070- coverage
7171- section-index
7272- mkdocstrings :
73- handlers :
74- python :
75- import :
76- - https://mkdocstrings.github.io/objects.inv
77- rendering :
78- show_submodules : no
7973 watch :
8074 - src/mkdocstrings_handlers
8175
Original file line number Diff line number Diff line change @@ -44,6 +44,9 @@ Discussions = "https://github.com/mkdocstrings/python/discussions"
4444Gitter = " https://gitter.im/python/community"
4545Funding = " https://github.com/sponsors/mkdocstrings"
4646
47+ [project .scripts ]
48+ mkdocstrings-python = " mkdocstrings_handlers.cli:main"
49+
4750[tool .pdm ]
4851version = {use_scm = true }
4952includes = [" src/mkdocstrings_handlers" ]
@@ -109,5 +112,5 @@ multi_line_output = 3
109112force_single_line = false
110113balanced_wrapping = true
111114default_section = " THIRDPARTY"
112- known_first_party = " mkdocstrings "
115+ known_first_party = " mkdocstrings_handlers "
113116include_trailing_comma = true
Original file line number Diff line number Diff line change 33
44PYTHON_VERSIONS=" ${PYTHON_VERSIONS-3.7 3.8 3.9 3.10 3.11} "
55
6+ restore_previous_python_version () {
7+ if pdm use -f " $1 " & > /dev/null; then
8+ echo " > Restored previous Python version: ${1##*/ } "
9+ fi
10+ }
11+
612if [ -n " ${PYTHON_VERSIONS} " ]; then
13+ old_python_version=" $( pdm config python.path) "
14+ echo " > Currently selected Python version: ${old_python_version##*/ } "
15+ trap " restore_previous_python_version ${old_python_version} " EXIT
716 for python_version in ${PYTHON_VERSIONS} ; do
817 if pdm use -f " python${python_version} " & > /dev/null; then
9- echo " > pdm run $@ (Python ${python_version} )"
18+ echo " > pdm run $@ (python ${python_version} )"
1019 pdm run " $@ "
1120 else
1221 echo " > pdm use -f python${python_version} : Python interpreter not available?" >&2
Original file line number Diff line number Diff line change 1- """Tests suite for `mkdocstrings `."""
1+ """Tests suite for `mkdocstrings_handlers `."""
22
33from pathlib import Path
44
You can’t perform that action at this time.
0 commit comments