Merge pull request #35 from biaslyze-dev/highlight-keywords-dashboard

Add highlights to selected texts and other stuff

Makefile

@@ -5,18 +5,24 @@ install:
 jupyter:
 	poetry run jupyter lab
 
-doc-preview:
+doc-check:
+	poetry run pydocstyle biaslyze/
+
+doc-preview: doc-check
 	poetry run gendocs --config mkgendocs.yml
 	poetry run mkdocs serve --dirtyreload
 
-doc:
+doc: doc-check
 	poetry run gendocs --config mkgendocs.yml
 	poetry run mkdocs build
 
 style:
 	poetry run isort .
 	poetry run black .
 
+typing:
+	poetry run mypy --disable-error-code=import biaslyze/
+
 lint:
 	poetry run ruff biaslyze/ --ignore E501
 

README.md

@@ -75,7 +75,7 @@ See more detailed examples in the [tutorial](https://biaslyze.org/tutorials/tuto
 
 ### Adding concepts and keywords
 
-You can add concepts and new keywords for existing concepts by editing [concepts.py](https://github.com/biaslyze-dev/biaslyze/blob/main/biaslyze/concepts.py).
+You can add concepts and new keywords for existing concepts by editing the concept files in [concepts](https://github.com/biaslyze-dev/biaslyze/blob/main/biaslyze/concepts/).
 A tutorial on how to create custom concepts and work with them can be found [here](https://biaslyze.org/tutorials/tutorial-working-with-custom-concepts/).
 
 ## Preview/build the documentation with mkdocs

biaslyze/__init__.py

@@ -0,0 +1 @@
+"""This module contains the main code for the biaslyze package."""