aljaz/Auto-GPT
1
0
Fork 0
mirror of https://github.com/aljazceru/Auto-GPT.git synced 2025-12-18 14:34:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Re-work Docs and split out README (using MkDocs) (#2894)

Browse Source 
* Initial Documentation re-org

* remove testing link from readme

* rewrite quickstart

* get code blocks working across mkdocs and github

* add link to plugins repo

* add link to plugins repo and move readme to plugin template repo

* Add emoji to "Extensibility with Plugins" in readme

Co-authored-by: Reinier van der Leer <github@pwuts.nl>

* Make docs deploy workflow path-selective

* Also run workflow when the workflow is updated

* fix readme links under configuration subfolder

* shrink subheadings in readme

---------

Co-authored-by: Toran Bruce Richards <toran.richards@gmail.com>
Co-authored-by: Reinier van der Leer <github@pwuts.nl>
This commit is contained in:
Richard Beales
2023-04-22 12:56:22 +01:00
committed by GitHub
parent e9f3f9bd1d
commit ad5d8b2341
14 changed files with 564 additions and 494 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/testing.md Normal file
View File

@@ -0,0 +1,39 @@
## Run tests
To run all tests, run the following command:
```
pytest
```
To run just without integration tests:
```
pytest --without-integration
```
To run just without slow integration tests:
```
pytest --without-slow-integration
```
To run tests and see coverage, run the following command:
```
pytest --cov=autogpt --without-integration --without-slow-integration
```
## Run linter
This project uses [flake8](https://flake8.pycqa.org/en/latest/) for linting. We currently use the following rules: `E303,W293,W291,W292,E305,E231,E302`. See the [flake8 rules](https://www.flake8rules.com/) for more information.
To run the linter, run the following command:
```
flake8 autogpt/ tests/
# Or, if you want to run flake8 with the same configuration as the CI:
flake8 autogpt/ tests/ --select E303,W293,W291,W292,E305,E231,E302
```