https://github.com/finsberg/blacken-docs-jb

Extension of blancken-docs for jupyterbook
https://github.com/finsberg/blacken-docs-jb

Last synced: 3 days ago
JSON representation

Extension of blancken-docs for jupyterbook

• Host: GitHub
• URL: https://github.com/finsberg/blacken-docs-jb
• Owner: finsberg
• License: mit
• Created: 2022-10-22T21:53:15.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-09T08:37:40.000Z (almost 2 years ago)
• Last Synced: 2024-09-21T14:13:37.295Z (about 2 months ago)
• Language: Python
• Size: 204 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# blacken-docs-jb

Extension of [blacken-docs](https://github.com/asottile/blacken-docs) which also supports the [executable code blocks](https://jupyterbook.org/en/stable/reference/cheatsheet.html#executable-code) from [JupyterBook](https://jupyterbook.org) e.g

````

```{code-cell} python

x = 1 + 2

```

````

## Install

```bash

pip install blacken-docs-jb

```

## Usage with pre-commit

See [pre-commit](https://pre-commit.com) for instructions

Sample `.pre-commit-config.yaml`:

```yaml

- repo: https://github.com/finsberg/blacken-docs-jb

    rev: v0.6.2

    hooks:

      - id: blacken-docs-jb

        additional_dependencies: [black==22.3.0]

        exclude: slides

```

## License

This project is licensed under [MIT](LICENSE). The license file from blacken-docs is found in [LICENSE_blacken_docs](LICENSE_blacken_docs).