Merge pull request #125 from james-bellamy/fixes

Fix requirements to allow doc creation
alertlogic · Apr 25, 2023 · 6f49dbf · 6f49dbf
2 parents 0e782c1 + 40f3a7a
commit 6f49dbf
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -124,6 +124,11 @@ venv.bak/
 # mkdocs documentation
 /site
 
+docs/site
+docs/almdrlib.docs.rst
+docs/almdrlib.rst
+docs/modules.rst
+
 # mypy
 .mypy_cache/
 .dmypy.json
@@ -135,3 +140,10 @@ dmypy.json
 # IntelliJ
 *.iml
 .idea
+
+# VS code
+.vscode
+
+# Node
+node_modules
+package-lock.json
diff --git a/docs/Makefile b/docs/Makefile
@@ -12,7 +12,7 @@ BUILDDIR      = _build
 
 APISDIR       = $(shell printf "import alsdkdefs\nprint(alsdkdefs.get_apis_dir())" | python)
 APIDOCSDIR	  = ./$(BUILDDIR)/api_html
-APISPECFILES  := $(shell find $(APISDIR) -name '*.yaml')
+APISPECFILES  := $(shell find $(APISDIR) -regex ".*.v[0-9]*.yaml")
 APIDOCFILES   := $(subst $(APISDIR),$(APIDOCSDIR),$(APISPECFILES:%.yaml=%.html))
 
 VPATH 		  = $(APISDIR)

diff --git a/requirements.txt b/requirements.txt
@@ -6,3 +6,6 @@ pyyaml==5.4.1
 jsonschema[format_nongpl]==3.2.0
 m2r2==0.3.2
 boto3>=1.16.57
+markupsafe==2.0.1
+sphinxcontrib-contentui
+sphinx_paramlinks