From c8dd60bd44bb50f7eb09658d6cacb18f22737bdf Mon Sep 17 00:00:00 2001 From: jh-RLI Date: Wed, 23 Aug 2023 09:28:33 +0200 Subject: [PATCH] fix typos #21 --- ...ow.md => test-driven-development-workflow.md} | 0 docs/development/continuous-integration/index.md | 16 ++++++++++++++-- mkdocs.yml | 5 +++-- 3 files changed, 17 insertions(+), 4 deletions(-) rename docs/development/best-practice/{test-driven-developement-workflow.md => test-driven-development-workflow.md} (100%) diff --git a/docs/development/best-practice/test-driven-developement-workflow.md b/docs/development/best-practice/test-driven-development-workflow.md similarity index 100% rename from docs/development/best-practice/test-driven-developement-workflow.md rename to docs/development/best-practice/test-driven-development-workflow.md diff --git a/docs/development/continuous-integration/index.md b/docs/development/continuous-integration/index.md index 980a0f7..6ea74df 100644 --- a/docs/development/continuous-integration/index.md +++ b/docs/development/continuous-integration/index.md @@ -15,13 +15,25 @@ pip install tox !!! Note [Tox](https://tox.wiki/en/4.9.0/) is a versatile tool that integrates comprehensive testing into your framework. Combined with a runner like GitHub Actions, it allows you to automate a wide range of tasks. + ??? Info "What is tox" + Tox is a popular open-source tool in the Python ecosystem that helps automate and manage the process of testing Python projects across multiple environments. It addresses the challenge of ensuring that a Python project works correctly and consistently across various versions of Python interpreters and dependencies. + + In summary, Tox is a powerful tool that simplifies and automates the process of testing Python projects across different environments. It ensures that your code is reliable, functional, and compatible with various Python versions and dependencies, ultimately leading to higher code quality and more robust software. + +??? Info "Key features and functionalities" + + Tox creates isolated virtual environments for each specified Python version. This is crucial because different projects might have different dependencies or require specific Python versions. Isolation prevents conflicts between packages used by different projects. + + + + Configuring `tox` may involve some complexity. Start by defining what tests you want to run and what dependencies (such as packages or external services) are required for the tests. Organize these test tasks into logical steps. !!! Warning "Missing" Refer to our comprehensive guide on configuring `tox` for detailed instructions. !!! Info "Run test on multiple platforms" - Our Tox environments are executed on all major platofrms including windows, linux and macos. + Our Tox environments are executed on all major platforms including windows, linux and macos. ### Configure Continuous Integration using GitHub Actions @@ -64,7 +76,7 @@ These options allow you to closely monitor the progress and outcomes of your CI ## Add new code test -To add a new test for any new functuionality you have added or you plan to add you should add a test. The test is imply added to the tests/ +To add a new test for any new functionality you have added or you plan to add you should add a test. The test is imply added to the tests/ directory. See our examples .... \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 4be119c..8f1601d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,6 +40,7 @@ markdown_extensions: - admonition - toc: permalink: "#" + - pymdownx.details - pymdownx.superfences - pymdownx.highlight: use_pygments: true @@ -67,14 +68,14 @@ nav: - Contributing: development/collaboration/contributing.md - Users: development/collaboration/users.md - Code of Conduct: development/collaboration/code_of_conduct.md - - Continous Integration: + - Continuous Integration: - development/continuous-integration/index.md - Git: - development/git/index.md - Gitignore: development/git/gitignore.md - Best-Practice: - development/best-practice/index.md - - Test-Driven-Developement: development/best-practice/test-driven-developement-workflow.md + - Test-Driven-Development: development/best-practice/test-driven-development-workflow.md - Documentation: - development/documentation/index.md - Release: