Add tests for docs (#105)

* add tests for docs * update cloudformation_actions.py * fix dependencies for docs Co-authored-by: Ramon <[email protected]>
Skyscanner · May 31, 2022 · 4327efd · 4327efd
1 parent bd2dbf8
commit 4327efd
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 2 deletions.
diff --git a/.github/workflows/test-docs.yml b/.github/workflows/test-docs.yml
@@ -0,0 +1,21 @@
+name: Test Docs
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    name: Test Docs
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - run: make install-docs
+
+      - run: make test-docs
diff --git a/.gitignore b/.gitignore
@@ -103,10 +103,13 @@ venv.bak/
 # mkdocs documentation
 /site
 
+# MkDocs local builds
+site/
+
 # mypy
 .mypy_cache/
 
 .project
 
 # Snyk Code
-.dccache
+.dccache
diff --git a/Makefile b/Makefile
@@ -39,6 +39,9 @@ coverage:
 
 test: lint unit
 
+test-docs:
+	mkdocs build --strict
+
 freeze:
 	CUSTOM_COMPILE_COMMAND="make freeze" pip-compile --no-emit-index-url --no-annotate --output-file requirements.txt setup.py
 

diff --git a/pycfmodel/cloudformation_actions.py b/pycfmodel/cloudformation_actions.py
@@ -3190,6 +3190,7 @@
     "discovery:DisassociateConfigurationItemsFromApplication",
     "discovery:ExportConfigurations",
     "discovery:GetDiscoverySummary",
+    "discovery:GetNetworkConnectionGraph",
     "discovery:ListConfigurations",
     "discovery:ListServerNeighbors",
     "discovery:StartContinuousExport",
@@ -3264,6 +3265,8 @@
     "drs:AssociateFailbackClientToRecoveryInstanceForDrs",
     "drs:BatchCreateVolumeSnapshotGroupForDrs",
     "drs:BatchDeleteSnapshotRequestForDrs",
+    "drs:CreateConvertedSnapshotForDrs",
+    "drs:CreateExtendedSourceServer",
     "drs:CreateRecoveryInstanceForDrs",
     "drs:CreateReplicationConfigurationTemplate",
     "drs:CreateSessionForDrs",
@@ -3297,6 +3300,8 @@
     "drs:GetSuggestedFailbackClientDeviceMappingForDrs",
     "drs:InitializeService",
     "drs:IssueAgentCertificateForDrs",
+    "drs:ListExtensibleSourceServers",
+    "drs:ListStagingAccounts",
     "drs:ListTagsForResource",
     "drs:NotifyAgentAuthenticationForDrs",
     "drs:NotifyAgentConnectedForDrs",
@@ -4501,6 +4506,20 @@
     "emr-containers:StartJobRun",
     "emr-containers:TagResource",
     "emr-containers:UntagResource",
+    "emr-serverless:CancelJobRun",
+    "emr-serverless:CreateApplication",
+    "emr-serverless:DeleteApplication",
+    "emr-serverless:GetApplication",
+    "emr-serverless:GetJobRun",
+    "emr-serverless:ListApplications",
+    "emr-serverless:ListJobRuns",
+    "emr-serverless:ListTagsForResource",
+    "emr-serverless:StartApplication",
+    "emr-serverless:StartJobRun",
+    "emr-serverless:StopApplication",
+    "emr-serverless:TagResource",
+    "emr-serverless:UntagResource",
+    "emr-serverless:UpdateApplication",
     "es:AcceptInboundConnection",
     "es:AcceptInboundCrossClusterSearchConnection",
     "es:AddTags",
@@ -8304,12 +8323,14 @@
     "networkmanager:ListConnectPeers",
     "networkmanager:ListCoreNetworkPolicyVersions",
     "networkmanager:ListCoreNetworks",
+    "networkmanager:ListOrganizationServiceAccessStatus",
     "networkmanager:ListTagsForResource",
     "networkmanager:PutCoreNetworkPolicy",
     "networkmanager:PutResourcePolicy",
     "networkmanager:RegisterTransitGateway",
     "networkmanager:RejectAttachment",
     "networkmanager:RestoreCoreNetworkPolicyVersion",
+    "networkmanager:StartOrganizationServiceAccessUpdate",
     "networkmanager:StartRouteAnalysis",
     "networkmanager:TagResource",
     "networkmanager:UntagResource",

diff --git a/setup.py b/setup.py
@@ -17,7 +17,13 @@
     "pytest-cov>=2.10.1",
 ]
 
-docs_requires = ["AutoMacDoc==0.3", "mkdocs-material==4.6.3", "mkdocs==1.3.0", "mkdocstrings==0.10.0"]
+docs_requires = [
+    "AutoMacDoc==0.3",
+    "livereload==2.6.3",
+    "mkdocs-material==4.6.3",
+    "mkdocs==1.3.0",
+    "mkdocstrings==0.10.0",
+]
 
 setup(
     name="pycfmodel",