Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consolidate docs build #257

Merged
merged 2 commits into from
Jul 4, 2024
Merged

Consolidate docs build #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4be1d13
Update CI/CD workflows to match pre-commit hooks
CasperWA Jul 4, 2024
4ae2a0a
Update documentation according to specific setup
CasperWA Jul 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/workflows/ci_cd_updated_master.yml
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading