Skip to content

Commit

Permalink
Consolidate docs build (#257)
Browse files Browse the repository at this point in the history
Update CI/CD workflows to match pre-commit hooks
This is relevant only for building and testing the documentation.

Update documentation according to specific setup.
  • Loading branch information
CasperWA authored Jul 4, 2024
1 parent a489f32 commit 4511b21
Show file tree
Hide file tree
Showing 12 changed files with 32 additions and 1 deletion.
7 changes: 7 additions & 0 deletions .github/workflows/ci_cd_updated_master.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
6 changes: 6 additions & 0 deletions .github/workflows/ci_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }})
Expand Down
2 changes: 2 additions & 0 deletions docs/api_reference/models/session.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# session

::: oteapi_dlite.models.session
options:
show_if_no_docstring: true
2 changes: 2 additions & 0 deletions docs/api_reference/strategies/convert.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# convert

::: oteapi_dlite.strategies.convert
options:
show_if_no_docstring: true
2 changes: 2 additions & 0 deletions docs/api_reference/strategies/filter.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# filter

::: oteapi_dlite.strategies.filter
options:
show_if_no_docstring: true
2 changes: 2 additions & 0 deletions docs/api_reference/strategies/generate.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# generate

::: oteapi_dlite.strategies.generate
options:
show_if_no_docstring: true
2 changes: 2 additions & 0 deletions docs/api_reference/strategies/mapping.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# mapping

::: oteapi_dlite.strategies.mapping
options:
show_if_no_docstring: true
2 changes: 2 additions & 0 deletions docs/api_reference/strategies/parse.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# parse

::: oteapi_dlite.strategies.parse
options:
show_if_no_docstring: true
2 changes: 2 additions & 0 deletions docs/api_reference/strategies/parse_excel.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# parse_excel

::: oteapi_dlite.strategies.parse_excel
options:
show_if_no_docstring: true
2 changes: 2 additions & 0 deletions docs/api_reference/strategies/parse_image.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# parse_image

::: oteapi_dlite.strategies.parse_image
options:
show_if_no_docstring: true
2 changes: 2 additions & 0 deletions docs/api_reference/strategies/serialise.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# serialise

::: oteapi_dlite.strategies.serialise
options:
show_if_no_docstring: true
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 4511b21

Please sign in to comment.