Skip to content

Commit

Permalink
link to rtd (#64)
Browse files Browse the repository at this point in the history
* link to rtd

* link to rtd
  • Loading branch information
MarcoGorelli committed Jul 17, 2020
1 parent a9e73b4 commit 5b725b8
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 3 deletions.
22 changes: 20 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. image:: ../assets/output-onlinepngtools.png
:width: 300
.. image:: https://github.com/MarcoGorelli/nbQA/raw/master/assets/output-onlinepngtools.png
:width: 400

====
nbQA
Expand All @@ -14,7 +14,11 @@ nbQA
.. image:: https://badge.fury.io/py/nbqa.svg
:target: https://badge.fury.io/py/nbqa

.. image:: https://readthedocs.org/projects/nbqa/badge/?version=latest&style=plastic
:target: https://nbqa.readthedocs.io/en/latest/

Adapter to run any code-quality tool on a Jupyter notebook. Zero dependencies, runs on Python3.6+.
Documentation is hosted here_.

Installation
------------
Expand Down Expand Up @@ -59,9 +63,23 @@ In practice, here are the tools it's been tested with:
- mypy_ (you will need to have `__init__` files in each subdirectory)
- doctest_ (as long as you run it via pytest_ with the `--doctest-modules` flag)

See Also
--------

Here are some other code quality tools for Jupyter Notebooks:

- flake-nb_;
- black-nb_.

Project template from cookiecutter_.

.. _cookiecutter: https://github.com/cookiecutter/cookiecutter
.. _flake8: https://flake8.pycqa.org/en/latest/
.. _black: https://black.readthedocs.io/en/stable/
.. _pytest: https://docs.pytest.org/en/latest/
.. _isort: https://timothycrosley.github.io/isort/
.. _mypy: http://mypy-lang.org/
.. _doctest: https://docs.python.org/3/library/doctest.html
.. _black: https://github.com/tomcatling/black-nb
.. _flake8-nb: https://flake8-nb.readthedocs.io/en/latest/readme.html
.. _here: https://nbqa.readthedocs.io/en/latest/
Binary file modified assets/output-onlinepngtools.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. image:: ../assets/output-onlinepngtools.png
.. image:: https://github.com/MarcoGorelli/nbQA/raw/master/assets/output-onlinepngtools.png
:width: 400

nbQA
Expand Down

0 comments on commit 5b725b8

Please sign in to comment.