Skip to content

Commit a8d97fc

Browse files
committed
various additional documentation build fixes
- fixed package upload waiting workflow - fixing sphinx trying to generate pydantic docstrings - fixed appmetadata jsonscheme --> RST warnings
1 parent 9f402f3 commit a8d97fc

4 files changed

Lines changed: 8 additions & 6 deletions

File tree

.github/workflows/containers.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
- name: "⏱️ Wait up to 20 minutes for the new clams-python is deployed on PyPI"
4040
uses: nev7n/wait_for_response@v1
4141
with:
42-
url: "https://pypi.org/project/clams-python/${{ needs.set-version.outputs.version }}/"
42+
url: "https://pypi.org/pypi/clams-python/${{ needs.set-version.outputs.version }}/json"
4343
responseCode: 200
4444
timeout: 1200000
4545
interval: 5000

container/generate_containers_yml.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ def generate_workflow(container_files, dependencies, output_file):
6363
f.write(" - name: \"⏱️ Wait up to 20 minutes for the new clams-python is deployed on PyPI\"\n")
6464
f.write(" uses: nev7n/wait_for_response@v1\n")
6565
f.write(" with:\n")
66-
f.write(" url: \"https://pypi.org/project/clams-python/${{ needs.set-version.outputs.version }}/\"\n")
66+
f.write(" url: \"https://pypi.org/pypi/clams-python/${{ needs.set-version.outputs.version }}/json\"\n")
6767
f.write(" responseCode: 200\n")
6868
f.write(" timeout: 1200000\n")
6969
f.write(" interval: 5000\n")

documentation/appmetadata.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,9 +228,11 @@ Metadata Schema
228228
The schema for app metadata is as follows.
229229
(You can also download the schema in `JSON Schema <https://json-schema.org/>`_ format from `here <appmetadata.jsonschema>`_.)
230230

231-
.. jsonschema:: appmetadata.jsonschema
231+
.. jsonschema:: appmetadata.jsonschema
232232
:lift_description: True
233233
:lift_title: True
234234
:lift_definitions: True
235+
:auto_target: True
236+
:auto_reference: True
235237

236238

documentation/autodoc/clams.appmetadata.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ Package providing classes for representing metadata of CLAMS apps.
88

99
.. autoclass:: clams.appmetadata.Input
1010
:members:
11-
:inherited-members:
11+
:inherited-members: BaseModel
1212

1313
.. autoclass:: clams.appmetadata.Output
1414
:members:
15-
:inherited-members:
15+
:inherited-members: BaseModel
1616

1717
.. autoclass:: clams.appmetadata.RuntimeParameter
1818
:members:
19-
:inherited-members:
19+
:inherited-members: BaseModel

0 commit comments

Comments
 (0)