From f9ee9991a05a98535fea4680328edb274abbfaa6 Mon Sep 17 00:00:00 2001 From: Bilawal Hameed Date: Tue, 23 Jun 2020 20:45:22 +0200 Subject: [PATCH] docs(techdocs-core): added linting section --- .../techdocs/mkdocs/container/techdocs-core/README.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/plugins/techdocs/mkdocs/container/techdocs-core/README.md b/plugins/techdocs/mkdocs/container/techdocs-core/README.md index b4a32a57cb..143acf3c3b 100644 --- a/plugins/techdocs/mkdocs/container/techdocs-core/README.md +++ b/plugins/techdocs/mkdocs/container/techdocs-core/README.md @@ -35,14 +35,11 @@ In the parent `Dockerfile` we add this folder to the build and install the packa See the `README.md` located in the `mkdocs/` folder for more details on how to build and run the Docker container. -## Linting and Tests - -To run the tests, you'll need `tox` installed with our dependencies installed: +## Linting ```bash -pip install tox pip install -r requirements.txt -tox +python -m black src/ ``` -This will invoke our linter and tests. You can configure this by editing the `tox.ini` folder located in this folder. +**Note:** This will write to all Python files in `src/` with the formatted code. If you would like to only check to see if it passes, simply append the `--check` flag.