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")
```
(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 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.2.4
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.2.4.tar.gz
(5.2 kB
view hashes)
Built Distribution
Close
Hashes for pyupgrade_docs-0.2.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8adad671ce2acc24030c09a283eb17a1c2aac26b385c20deeeb7cdc26ad487d5 |
|
MD5 | e014fb80bf0558c7c0b198171b0ccc9b |
|
BLAKE2b-256 | 4c937047d3107d58418e56ba607ae1513a016e3ff268687115e0a768ac9e174c |