docs: update documentation url (#1982)

* chore: update docs and make file

* fix make check error

* chore: remove double `--cov-append` flags in make file

* chore: update make file

Author: waketzheng

Makefile

@@ -33,10 +33,8 @@ check: build _check
 _check:
 	ruff format --check $(checkfiles) || (echo "Please run 'make style' to auto-fix style issues" && false)
 	ruff check $(checkfiles)
-	mypy $(checkfiles)
 	#pylint -d C,W,R $(checkfiles)
-	#bandit -r $(checkfiles)make
-	twine check dist/*
+	$(MAKE) _codeqc
 
 style: deps _style
 _style:
@@ -46,6 +44,10 @@ _style:
 lint: build _lint
 _lint:
 	$(MAKE) _style
+	$(MAKE) _codeqc
+
+codeqc: build _typehints
+_codeqc:
 	mypy $(checkfiles)
 	bandit -c pyproject.toml -r $(checkfiles)
 	twine check dist/*
@@ -60,16 +62,16 @@ test_sqlite_regexp:
 	$(py_warn) TORTOISE_TEST_DB=sqlite://:memory:?install_regexp_functions=True pytest --cov-report= $(pytest_opts)
 
 test_postgres_asyncpg:
-	python -V | grep PyPy || $(py_warn) TORTOISE_TEST_DB="asyncpg://postgres:$(TORTOISE_POSTGRES_PASS)@127.0.0.1:5432/test_\{\}" pytest $(pytest_opts) --cov-append --cov-report=
+	python -V | grep PyPy || $(py_warn) TORTOISE_TEST_DB="asyncpg://postgres:$(TORTOISE_POSTGRES_PASS)@127.0.0.1:5432/test_\{\}" pytest $(pytest_opts) --cov-report=
 
 test_postgres_psycopg:
-	python -V | grep PyPy || $(py_warn) TORTOISE_TEST_DB="psycopg://postgres:$(TORTOISE_POSTGRES_PASS)@127.0.0.1:5432/test_\{\}" pytest $(pytest_opts) --cov-append --cov-report=
+	python -V | grep PyPy || $(py_warn) TORTOISE_TEST_DB="psycopg://postgres:$(TORTOISE_POSTGRES_PASS)@127.0.0.1:5432/test_\{\}" pytest $(pytest_opts) --cov-report=
 
 test_mysql_myisam:
-	$(py_warn) TORTOISE_TEST_DB="mysql://root:$(TORTOISE_MYSQL_PASS)@127.0.0.1:3306/test_\{\}?storage_engine=MYISAM" pytest $(pytest_opts) --cov-append --cov-report=
+	$(py_warn) TORTOISE_TEST_DB="mysql://root:$(TORTOISE_MYSQL_PASS)@127.0.0.1:3306/test_\{\}?storage_engine=MYISAM" pytest $(pytest_opts) --cov-report=
 
 test_mysql:
-	$(py_warn) TORTOISE_TEST_DB="mysql://root:$(TORTOISE_MYSQL_PASS)@127.0.0.1:3306/test_\{\}" pytest $(pytest_opts) --cov-append --cov-report=
+	$(py_warn) TORTOISE_TEST_DB="mysql://root:$(TORTOISE_MYSQL_PASS)@127.0.0.1:3306/test_\{\}" pytest $(pytest_opts) --cov-report=
 
 test_mysql_asyncmy:
 	$(MAKE) deps_with_asyncmy
@@ -78,18 +80,18 @@ test_mysql_asyncmy:
 	$(MAKE) deps
 
 test_mssql:
-	$(py_warn) TORTOISE_TEST_DB="mssql://sa:$(TORTOISE_MSSQL_PASS)@127.0.0.1:1433/test_\{\}?driver=$(TORTOISE_MSSQL_DRIVER)&TrustServerCertificate=YES" pytest $(pytest_opts) --cov-append --cov-report=
+	$(py_warn) TORTOISE_TEST_DB="mssql://sa:$(TORTOISE_MSSQL_PASS)@127.0.0.1:1433/test_\{\}?driver=$(TORTOISE_MSSQL_DRIVER)&TrustServerCertificate=YES" pytest $(pytest_opts) --cov-report=
 
 test_oracle:
-	$(py_warn) TORTOISE_TEST_DB="oracle://SYSTEM:$(TORTOISE_ORACLE_PASS)@127.0.0.1:1521/test_\{\}?driver=$(TORTOISE_ORACLE_DRIVER)" pytest $(pytest_opts) --cov-append --cov-report=
+	$(py_warn) TORTOISE_TEST_DB="oracle://SYSTEM:$(TORTOISE_ORACLE_PASS)@127.0.0.1:1521/test_\{\}?driver=$(TORTOISE_ORACLE_DRIVER)" pytest $(pytest_opts) --cov-report=
 
 _testall: test_sqlite test_postgres_asyncpg test_postgres_psycopg test_mysql_myisam test_mysql test_mysql_asyncmy test_mssql
 
 	coverage report
 
 testall: deps _testall
 
-ci: build _check _testall
+ci: check _testall
 
 docs: deps
 	rm -fR ./build
@@ -99,5 +101,5 @@ build: deps
 	rm -fR dist/
 	poetry build
 
-publish: deps build
+publish: deps _build
 	twine upload dist/*

docs/CONTRIBUTING.rst

@@ -115,15 +115,14 @@ Different types of tests
 - ``make test_mysql``: Runs the tests on the mysql database
 - ``make testall``: runs the tests on all 4 database types: sqlite (in memory), postgresql, MySQL-MyISAM and MySQL-InnoDB
 - ``green``: runs the same tests as ``make test``, ensures the green plugin works
-- ``nose2 --plugin tortoise.contrib.test.nose2 --db-module tests.testmodels --db-url sqlite://:memory: ``: same test as ``make test`` , ensures the nose2 plugin works
 
 
 Things to be aware of when running the test suite
 ---------------------------------------------------
 - Some tests always run regardless of what test suite you are running (the connection tests for mysql and postgres for example, you don't need a database running as it doesn't actually connect though)
 - Some tests use hardcoded databases (usually sqlite) for testing, regardless of what DB url you specified.
 - The postgres driver does not work under Pypy so those tests will be skipped if you are running under pypy
-- You can run only specific tests by running `` py.test <testfiles>`` or ``green -s 1 <testfile>``
+- You can run only specific tests by running ``pytest <testfiles>`` or ``green -s 1 <testfile>``
 - If you want a peek under the hood of test that hang to debug try running them with ``green -s 1 -vv -d -a <test>``
     - ``-s 1`` means it only runs one test at a time
     - ``-vv`` very verbose output

pyproject.toml

@@ -30,9 +30,9 @@ psycopg = ["psycopg[pool,binary] (>=3.0.12,<4.0.0)"]
 asyncodbc = ["asyncodbc (>=0.1.1,<1.0.0); python_version < '4.0'"]
 
 [project.urls]
+documentation = "https://tortoise.github.io"
 homepage = "https://github.com/tortoise/tortoise-orm"
 repository = "https://github.com/tortoise/tortoise-orm.git"
-documentation = "https://tortoise-orm.readthedocs.io"
 
 [tool.poetry]
 requires-poetry = ">=2.0"