Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add mkdocs and pre-commit hooks #370

Open
AmineDjeghri opened this issue Dec 9, 2024 · 1 comment
Open

add mkdocs and pre-commit hooks #370

AmineDjeghri opened this issue Dec 9, 2024 · 1 comment

Comments

@AmineDjeghri
Copy link
Contributor

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

@AmineDjeghri
Copy link
Contributor Author

Done in #371

I also added pre-commit. It flagged the naming of the test files not following the convention:

python tests naming......................................................Failed
- hook id: name-tests-test
- exit code: 1

tests/search.py does not match pattern "test_.*\.py"
tests/cache.py does not match pattern "test_.*\.py"
tests/store.py does not match pattern "test_.*\.py"
tests/llm.py does not match pattern "test_.*\.py"
tests/local.py does not match pattern "test_.*\.py"

@AmineDjeghri AmineDjeghri changed the title add mkdocs add mkdocs and pre-commit hooks Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant