diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/api_reference.md | 4 | ||||
-rw-r--r-- | docs/css/mkdocstrings.css | 11 | ||||
-rw-r--r-- | docs/getting_started.md | 89 | ||||
-rw-r--r-- | docs/index.md | 1 | ||||
-rw-r--r-- | docs/requirements.in | 3 |
5 files changed, 108 insertions, 0 deletions
diff --git a/docs/api_reference.md b/docs/api_reference.md new file mode 100644 index 0000000..5b69d1c --- /dev/null +++ b/docs/api_reference.md @@ -0,0 +1,4 @@ +API Reference +=============== + +::: argaze
\ No newline at end of file diff --git a/docs/css/mkdocstrings.css b/docs/css/mkdocstrings.css new file mode 100644 index 0000000..c213aed --- /dev/null +++ b/docs/css/mkdocstrings.css @@ -0,0 +1,11 @@ +[data-md-color-scheme="slate"] { + --doc-symbol-attribute-fg-color: #963fb8; + --doc-symbol-function-fg-color: #6d67e4; + --doc-symbol-class-fg-color: #46c2cb; + --doc-symbol-module-fg-color: #f2f7a1; + + --doc-symbol-attribute-bg-color: #963fb81a; + --doc-symbol-function-bg-color: #6d67e41a; + --doc-symbol-class-bg-color: #46c2cb1a; + --doc-symbol-module-bg-color: #f2f7a11a; +}
\ No newline at end of file diff --git a/docs/getting_started.md b/docs/getting_started.md new file mode 100644 index 0000000..4951a25 --- /dev/null +++ b/docs/getting_started.md @@ -0,0 +1,89 @@ +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.* diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..563ed56 --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +{!README.md!} diff --git a/docs/requirements.in b/docs/requirements.in new file mode 100644 index 0000000..bec300c --- /dev/null +++ b/docs/requirements.in @@ -0,0 +1,3 @@ +mkdocs +mkdocstrings[python] +markdown-include |