pyupgrade-docs 0.1.1

Run `pyupgrade` on python code blocks in documentation files

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 files in place.

It currently supports the following pyupgrade options:

• --keep-percent-format
• --py3-plus --py3-only
• --py36-plus

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")

usage with pre-commit

See pre-commit for instructions

Sample .pre-commit-config.yaml:

-   repo: https://github.com/verhovsky/pyupgrade-docs
    rev: v0.1.0
    hooks:
    -   id: pyupgrade-docs