diff --git a/.github/workflows/ci_cd_updated_master.yml b/.github/workflows/ci_cd_updated_master.yml index 9306b251..0a570be7 100644 --- a/.github/workflows/ci_cd_updated_master.yml +++ b/.github/workflows/ci_cd_updated_master.yml @@ -28,5 +28,12 @@ jobs: doc_extras: "[docs]" changelog_exclude_labels: "skip_changelog,duplicate,question,invalid,wontfix" docs_framework: mkdocs + full_docs_dirs: | + models + strategies + landing_page_replacements: | + (LICENSE),(LICENSE.md) + https://EMMC-ASBL.github.io/oteapi-dlite/latest/, + secrets: PAT: ${{ secrets.RELEASE_PAT }} diff --git a/.github/workflows/ci_tests.yml b/.github/workflows/ci_tests.yml index 647d56cb..1ddd1be5 100644 --- a/.github/workflows/ci_tests.yml +++ b/.github/workflows/ci_tests.yml @@ -59,6 +59,12 @@ jobs: update_python_api_ref: true update_docs_landing_page: true package_dirs: oteapi_dlite + full_docs_dirs: | + models + strategies + landing_page_replacements: | + (LICENSE),(LICENSE.md) + https://EMMC-ASBL.github.io/oteapi-dlite/latest/, pytest-linux: name: pytest (linux-py${{ matrix.python-version }}) diff --git a/docs/api_reference/models/session.md b/docs/api_reference/models/session.md index cf0ba083..5b56f9b8 100644 --- a/docs/api_reference/models/session.md +++ b/docs/api_reference/models/session.md @@ -1,3 +1,5 @@ # session ::: oteapi_dlite.models.session + options: + show_if_no_docstring: true diff --git a/docs/api_reference/strategies/convert.md b/docs/api_reference/strategies/convert.md index ebffb8b1..b938a010 100644 --- a/docs/api_reference/strategies/convert.md +++ b/docs/api_reference/strategies/convert.md @@ -1,3 +1,5 @@ # convert ::: oteapi_dlite.strategies.convert + options: + show_if_no_docstring: true diff --git a/docs/api_reference/strategies/filter.md b/docs/api_reference/strategies/filter.md index 35f18295..fca8a482 100644 --- a/docs/api_reference/strategies/filter.md +++ b/docs/api_reference/strategies/filter.md @@ -1,3 +1,5 @@ # filter ::: oteapi_dlite.strategies.filter + options: + show_if_no_docstring: true diff --git a/docs/api_reference/strategies/generate.md b/docs/api_reference/strategies/generate.md index bfb698c1..2c555359 100644 --- a/docs/api_reference/strategies/generate.md +++ b/docs/api_reference/strategies/generate.md @@ -1,3 +1,5 @@ # generate ::: oteapi_dlite.strategies.generate + options: + show_if_no_docstring: true diff --git a/docs/api_reference/strategies/mapping.md b/docs/api_reference/strategies/mapping.md index ba19a443..1f4ec563 100644 --- a/docs/api_reference/strategies/mapping.md +++ b/docs/api_reference/strategies/mapping.md @@ -1,3 +1,5 @@ # mapping ::: oteapi_dlite.strategies.mapping + options: + show_if_no_docstring: true diff --git a/docs/api_reference/strategies/parse.md b/docs/api_reference/strategies/parse.md index 28760162..3e0ced35 100644 --- a/docs/api_reference/strategies/parse.md +++ b/docs/api_reference/strategies/parse.md @@ -1,3 +1,5 @@ # parse ::: oteapi_dlite.strategies.parse + options: + show_if_no_docstring: true diff --git a/docs/api_reference/strategies/parse_excel.md b/docs/api_reference/strategies/parse_excel.md index 4277ff07..c3669697 100644 --- a/docs/api_reference/strategies/parse_excel.md +++ b/docs/api_reference/strategies/parse_excel.md @@ -1,3 +1,5 @@ # parse_excel ::: oteapi_dlite.strategies.parse_excel + options: + show_if_no_docstring: true diff --git a/docs/api_reference/strategies/parse_image.md b/docs/api_reference/strategies/parse_image.md index fc51228f..2e153f5e 100644 --- a/docs/api_reference/strategies/parse_image.md +++ b/docs/api_reference/strategies/parse_image.md @@ -1,3 +1,5 @@ # parse_image ::: oteapi_dlite.strategies.parse_image + options: + show_if_no_docstring: true diff --git a/docs/api_reference/strategies/serialise.md b/docs/api_reference/strategies/serialise.md index 4ade9c04..0fc56820 100644 --- a/docs/api_reference/strategies/serialise.md +++ b/docs/api_reference/strategies/serialise.md @@ -1,3 +1,5 @@ # serialise ::: oteapi_dlite.strategies.serialise + options: + show_if_no_docstring: true diff --git a/docs/index.md b/docs/index.md index 1b6a002f..d25d6816 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,7 +20,7 @@ Further reading: - [OTE-API Services Documentation](https://github.com/EMMC-ASBL/oteapi-services) - [DLite](https://github.com/SINTEF/dlite) -A list and documentation for all the strategies in this plugin can be found [here](https://EMMC-ASBL.github.io/oteapi-dlite/latest/all_strategies). +A list and documentation for all the strategies in this plugin can be found [here](all_strategies). ## License and copyright