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/getting_started.md | |
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/getting_started.md')
-rw-r--r-- | docs/getting_started.md | 89 |
1 files changed, 0 insertions, 89 deletions
diff --git a/docs/getting_started.md b/docs/getting_started.md deleted file mode 100644 index 4951a25..0000000 --- a/docs/getting_started.md +++ /dev/null @@ -1,89 +0,0 @@ -Getting started -===== -Here are all you need to deal with ArGaze library. - -!!! note - - *Consider that all inline commands below have to be executed into ArGaze root folder.* - -Installation ------------- - -Install build tool package: - -```console -pip install build -``` - -Then, build ArGaze package: -```console -python -m build -``` - -Then, install ArGaze package (replace VERSION by what has been built into dist folder): -```console -pip install ./dist/argaze-VERSION.whl -``` - -!!! note - - **As Argaze library developper** - *You should prefer to install the package in developer mode to test live code changes:* - - ``` - pip install -e . - ``` - -Documentation ------------- - -ArGaze has a standard MkDocs layout which is built by Read the Docs. You can build and view this documentation project locally. - -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 -``` - -## Cookbook - -The `argaze.utils` submodule is a good place to get ready made code examples. - - -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. - -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.* |