File tree Expand file tree Collapse file tree 5 files changed +16
-18
lines changed
Expand file tree Collapse file tree 5 files changed +16
-18
lines changed Original file line number Diff line number Diff line change @@ -8,12 +8,12 @@ copyright_date: '2021'
88copyright_holder : " Timoth\xE9 e Mazzucotelli"
99copyright_holder_email : pawamoy@pm.me
1010copyright_license : ISC License
11- project_description : A Python handler for mkdocstrings.
12- project_name : Python for mkdocstrings
13- python_package_command_line_name : mkdocstrings-python
14- python_package_distribution_name : mkdocstrings-python
11+ project_description : A legacy Python handler for mkdocstrings.
12+ project_name : Legacy Python handler for mkdocstrings.
13+ python_package_command_line_name : mkdocstrings-python-legacy
14+ python_package_distribution_name : mkdocstrings-python-legacy
1515python_package_import_name : mkdocstrings
16- repository_name : python
16+ repository_name : python-legacy
1717repository_namespace : mkdocstrings
1818repository_provider : github.com
1919use_precommit : false
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+ - ` Legacy Python handler for mkdocstrings. ` 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 @@ -10,7 +10,7 @@ Nothing easier!
1010Fork and clone the repository, then:
1111
1212``` bash
13- cd python
13+ cd python-legacy
1414make setup
1515```
1616
@@ -32,8 +32,6 @@ make setup
3232
3333You now have the dependencies installed.
3434
35- You can run the application with ` pdm run mkdocstrings-python [ARGS...] ` .
36-
3735Run ` make help ` to see all the available actions!
3836
3937## Tasks
Original file line number Diff line number Diff line change 1- # Python for mkdocstrings
1+ # Legacy Python handler for mkdocstrings.
22
33[ ![ ci] ( https://github.com/mkdocstrings/python-legacy/workflows/ci/badge.svg )] ( https://github.com/mkdocstrings/python-legacy/actions?query=workflow%3Aci )
44[ ![ documentation] ( https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat )] ( https://mkdocstrings.github.io/python-legacy/ )
5- [ ![ pypi version] ( https://img.shields.io/pypi/v/python.svg )] ( https://pypi.org/project/python/ )
5+ [ ![ pypi version] ( https://img.shields.io/pypi/v/mkdocstrings- python-legacy .svg )] ( https://pypi.org/project/mkdocstrings- python-legacy / )
66[ ![ gitpod] ( https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat )] ( https://gitpod.io/#https://github.com/mkdocstrings/python-legacy )
7- [ ![ gitter] ( https://badges.gitter.im/join%20chat.svg )] ( https://gitter.im/python /community )
7+ [ ![ gitter] ( https://badges.gitter.im/join%20chat.svg )] ( https://gitter.im/mkdocstrings /community )
88
9- A Python handler for mkdocstrings.
9+ A legacy Python handler for mkdocstrings.
1010
1111## Requirements
1212
13- Python for mkdocstrings requires Python 3.6 or above.
13+ Legacy Python handler for mkdocstrings. requires Python 3.6 or above.
1414
1515<details >
1616<summary >To install Python 3.6, I recommend using <a href =" https://github.com/pyenv/pyenv " ><code >pyenv</code ></a >.</summary >
@@ -36,12 +36,12 @@ pyenv global system 3.6.12
3636
3737With ` pip ` :
3838``` bash
39- python3.6 -m pip install mkdocstrings-python
39+ python3.6 -m pip install mkdocstrings-python-legacy
4040```
4141
4242With [ ` pipx ` ] ( https://github.com/pipxproject/pipx ) :
4343``` bash
4444python3.6 -m pip install --user pipx
4545
46- pipx install --python python3.6 mkdocstrings-python
46+ pipx install --python python3.6 mkdocstrings-python-legacy
4747```
Original file line number Diff line number Diff line change 1- site_name : " Python for mkdocstrings"
2- site_description : " A Python handler for mkdocstrings."
1+ site_name : " Legacy Python handler for mkdocstrings. "
2+ site_description : " A legacy Python handler for mkdocstrings."
33site_url : " https://mkdocstrings.github.io/python-legacy"
44repo_url : " https://github.com/mkdocstrings/python-legacy"
55repo_name : " mkdocstrings/python-legacy"
You can’t perform that action at this time.
0 commit comments