diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7a3aea3..87becc1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -113,8 +113,8 @@ jobs: shell: bash env: SHELLCHECK_OPTS: --exclude=SC2086 --exclude=SC2046 --exclude=SC2004 --exclude=SC2129 - - + + documentation: defaults: run: diff --git a/.github/workflows/sync-docs.yml b/.github/workflows/sync-docs.yml index e75afef..1cea952 100644 --- a/.github/workflows/sync-docs.yml +++ b/.github/workflows/sync-docs.yml @@ -35,7 +35,7 @@ jobs: rm -f target-repo/docs/sidebars-python-sdk.ts cp -r source-repo/docs/docs/python-sdk/* target-repo/docs/docs-python-sdk cp source-repo/docs/sidebars.ts target-repo/docs/sidebars-python-sdk.ts - + for entry in source-repo/docs/docs/*; do name=$(basename "$entry") if [ "$name" != "python-sdk" ]; then diff --git a/docs/README.md b/docs/README.md index 0c6c2c2..2fae12f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,39 +2,39 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. -### Installation +## Installation -``` +```bash $ yarn ``` -### Local Development +## Local Development -``` +```bash $ yarn start ``` This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. -### Build +## Build -``` +```bash $ yarn build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. -### Deployment +## Deployment Using SSH: -``` +```bash $ USE_SSH=true yarn deploy ``` Not using SSH: -``` +```bash $ GIT_USER= yarn deploy ``` diff --git a/docs/docs/python-sdk/guides/query_data.mdx b/docs/docs/python-sdk/guides/query_data.mdx index 2cc1492..fc7bc22 100644 --- a/docs/docs/python-sdk/guides/query_data.mdx +++ b/docs/docs/python-sdk/guides/query_data.mdx @@ -523,6 +523,7 @@ Values of type `str` will be parsed using the [Pendulum](https://pendulum.eustac ### Properties of attributes and relationships + By default, the [meta data or properties](https://docs.infrahub.app/topics/metadata) of attributes and relationships are not included. We can include these properties using the `property` argument of the SDK client's `all`, `filters` or `get` method. diff --git a/tasks.py b/tasks.py index bd478bc..965e604 100644 --- a/tasks.py +++ b/tasks.py @@ -1,5 +1,4 @@ import sys - from pathlib import Path from invoke import Context, task