Metadata-Version: 2.1
Name: mkdocstrings-python
Version: 0.1.0
Summary: A Python handler for mkdocstrings.
License: UNKNOWN
Author-email: Timothée Mazzucotelli <pawamoy@pm.me>
Requires-Python: >=3.8
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Project-URL: Changelog, https://mkdocstrings.github.io/python/changelog
Project-URL: Discussions, https://github.com/mkdocstrings/python/discussions
Project-URL: Documentation, https://mkdocstrings.github.io/python
Project-URL: Funding, https://github.com/sponsors/mkdocstrings
Project-URL: Gitter, https://gitter.im/python/community
Project-URL: Homepage, https://mkdocstrings.github.io/python
Project-URL: Issues, https://github.com/mkdocstrings/python/issues
Project-URL: Repository, https://github.com/mkdocstrings/python
Description-Content-Type: text/markdown
Description: # Python for mkdocstrings
        
        [![ci](https://github.com/mkdocstrings/python/workflows/ci/badge.svg)](https://github.com/mkdocstrings/python/actions?query=workflow%3Aci)
        [![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://mkdocstrings.github.io/python/)
        [![pypi version](https://img.shields.io/pypi/v/python.svg)](https://pypi.org/project/python/)
        [![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/python)
        [![gitter](https://badges.gitter.im/join%20chat.svg)](https://gitter.im/python/community)
        
        A Python handler for mkdocstrings.
        
        ## Requirements
        
        Python for mkdocstrings requires Python 3.6 or above.
        
        <details>
        <summary>To install Python 3.6, 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.6
        pyenv install 3.6.12
        
        # make it available globally
        pyenv global system 3.6.12
        ```
        </details>
        
        ## Installation
        
        With `pip`:
        ```bash
        python3.6 -m pip install mkdocstrings-python
        ```
        
        With [`pipx`](https://github.com/pipxproject/pipx):
        ```bash
        python3.6 -m pip install --user pipx
        
        pipx install --python python3.6 mkdocstrings-python
        ```

