diff options
author | Théo de la Hogue | 2023-06-06 17:46:24 +0200 |
---|---|---|
committer | Théo de la Hogue | 2023-06-06 17:46:24 +0200 |
commit | b109578ec1e8635aeb9f12c3a913108232347935 (patch) | |
tree | 27b309b6b5dfabc12b0d1c57cd43efc6ab6a35a3 /docs/contributor_guide | |
parent | fafa4b7e12147bab945a4b84ded53c6171d20427 (diff) | |
download | argaze-b109578ec1e8635aeb9f12c3a913108232347935.zip argaze-b109578ec1e8635aeb9f12c3a913108232347935.tar.gz argaze-b109578ec1e8635aeb9f12c3a913108232347935.tar.bz2 argaze-b109578ec1e8635aeb9f12c3a913108232347935.tar.xz |
Working on documentation architecture.
Diffstat (limited to 'docs/contributor_guide')
-rw-r--r-- | docs/contributor_guide/build_documentation.md | 23 | ||||
-rw-r--r-- | docs/contributor_guide/unitary_test.md | 33 |
2 files changed, 56 insertions, 0 deletions
diff --git a/docs/contributor_guide/build_documentation.md b/docs/contributor_guide/build_documentation.md new file mode 100644 index 0000000..20df1df --- /dev/null +++ b/docs/contributor_guide/build_documentation.md @@ -0,0 +1,23 @@ +Build documentation +=================== + +ArGaze has a standard MkDocs layout which is built by Read the Docs. You can build and view this documentation project locally. + +!!! note + + *Consider that all inline commands below have to be executed into ArGaze root folder.* + +Install required Python dependencies (MkDocs etc.): +```console +pip install -r docs/requirements.in +``` + +Run the mkdocs development server: +```console +mkdocs serve +``` + +Export the mkdocs site: +```console +mkdocs build +``` diff --git a/docs/contributor_guide/unitary_test.md b/docs/contributor_guide/unitary_test.md new file mode 100644 index 0000000..42cf24c --- /dev/null +++ b/docs/contributor_guide/unitary_test.md @@ -0,0 +1,33 @@ +Unitary test +============ + +ArGaze package unitary tests are based on [unittest](https://docs.python.org/fr/3.10/library/unittest.html) module. +Test files tree structure is mirroring the file tree structure of src/argaze folder. + +!!! note + + *Consider that all inline commands below have to be executed into ArGaze root folder.* + + +To run all unitary tests: + +```shell +python -m unittest discover ./src/argaze.test "*.py" +``` + +To run only submodule unitary tests: + +```shell +python -m unittest discover ./src/argaze.test/SUBMODULE "*.py" +``` + +To run only a single unitary test file from a submodule: + +```shell +python -m unittest discover ./src/argaze.test/SUBMODULE/ TEST_FILE.py +``` + +!!! note + + **Verbose mode** + *Use -v option to get more details.* |