chore: update model doc generation to remove unnecessary headlines. (#53)

* chore: update model doc generation to remove unnecessary headlines.

Signed-off-by: Jeff Napper <[email protected]>

* fix: remove submodule checkout that is not needed.

Signed-off-by: Jeff Napper <[email protected]>

* chore: label tests for acp-spec and create GHA-specific test target without the spec.

Signed-off-by: Jeff Napper <[email protected]>

---------

Signed-off-by: Jeff Napper <[email protected]>

Author: jnapper7

.github/workflows/run_check.yml

@@ -29,9 +29,6 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v4
-      with:
-        submodules: true
-        token: ${{ secrets.GH_PAT_REPO_ACCESS }}
 
     - name: Set up python ${{ env.PYTHON_VERSION }}
       id: setup-python
@@ -48,7 +45,7 @@ jobs:
       run: poetry check
 
     - name: Check code
-      run: make check
+      run: make test_gha
       shell: bash
 
     - name: Print summary

Makefile

@@ -114,4 +114,7 @@ test: setup_test
 check: test
 	scripts/check-models.sh
 
+test_gha: setup_test
+	poetry run pytest --exitfirst -vv -m "not needs_acp_spec" tests/
+
 all: install generate test

scripts/generate_model_autodoc.sh

@@ -5,26 +5,18 @@
 # Note: This script generates the sphinx rst docs for the 
 # package models.
 
-echo "API Models
-===============
-"
-
 for model in agntcy_acp/acp_v0/models/[a-z]*.py ; do
     awk -f - "${model}" <<'EOF'
 /^class/ && /BaseModel/ { 
     match($2, "[^(]+");
     MODEL = substr($2,RSTART,RLENGTH-RSTART+1);
-    printf("\n\`\`%s\`\`\n", MODEL);
-    print("***************************************");
-    printf(".. autopydantic_model:: agntcy_acp.models.%s\n", MODEL);
+    printf("\n.. autopydantic_model:: agntcy_acp.models.%s\n", MODEL);
     print("   :members:");
 }
 /^class/ && /Enum/ { 
     match($2, "[^(]+");
     MODEL = substr($2,RSTART,RLENGTH-RSTART+1);
-    printf("\n\`\`%s\`\`\n", MODEL);
-    print("***************************************");
-    printf(".. autoclass:: agntcy_acp.models.%s\n", MODEL);
+    printf("\n.. autoclass:: agntcy_acp.models.%s\n", MODEL);
     print("   :members:");
 }
 EOF

tests/test_oas_generator.py

@@ -7,6 +7,7 @@
 from openapi_spec_validator.readers import read_from_filename
 from deepdiff import diff
 
+@pytest.mark.needs_acp_spec
 @pytest.mark.parametrize(
     "test_filename, oas_ref_filename",
     [