Run `pyupgrade` on python code blocks in documentation files
Project description
pyupgrade-docs
Run pyupgrade
on python code blocks in documentation files.
install
pip install pyupgrade-docs
usage
pyupgrade-docs
provides a single executable (pyupgrade-docs
) which will modify
.rst
/ .md
/ .tex
files in place.
It currently supports the following pyupgrade
options:
--keep-percent-format
--keep-mock
--keep-runtime-typing
--py3-plus
--py3-only
--py36-plus
--py37-plus
--py38-plus
--py39-plus
--py310-plus
The following additional parameters can be used:
-E
/--skip-errors
pyupgrade-docs
will format code in the following block types:
(markdown)
```python
def hello():
print("hello world")
```
(markdown pycon
)
```pycon
>>> def hello():
... print("hello world")
...
```
(rst)
.. code-block:: python
def hello():
print("hello world")
(rst pycon
)
.. code-block:: pycon
>>> def hello():
... print("hello world")
...
(latex)
\begin{minted}{python}
def hello():
print("hello world")
\end{minted}
(latex pycon
)
\begin{minted}{pycon}
>>> def hello():
... print("hello world")
...
\end{minted}
(latex with pythontex)
\begin{pycode}
def hello():
print("hello world")
\end{pycode}
(markdown/rst in python docstrings)
def f():
"""docstring here
.. code-block:: python
print("hello world")
```python
print("hello world")
```
"""
usage with pre-commit
See pre-commit for instructions
Sample .pre-commit-config.yaml
:
- repo: https://github.com/verhovsky/pyupgrade-docs
rev: v0.3.0
hooks:
- id: pyupgrade-docs
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pyupgrade_docs-0.3.0.tar.gz
(5.2 kB
view hashes)
Built Distribution
Close
Hashes for pyupgrade_docs-0.3.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 346808225a2230cede1fd367d994ea0618a4d3e300c018a1df4d6ae6ed784ce9 |
|
MD5 | 9d85cb4d240eb4352f20df83ccf2293c |
|
BLAKE2b-256 | 9cb03cdd267e487ff1869268fd9a63bfff7e0e516a698439e18f01ddddb7a080 |