Docker Documentation Builds

.github/workflows/build_docs.yml

@@ -0,0 +1,41 @@
+name: deploy_dev_docs
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  build_docs:
+    name: build_dev_docs
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
+
+      - name: build documentation with docker
+        run: make docks
+
+      - uses: actions/checkout@v2
+        with:
+          ref: doc
+          path: doc-branch
+
+      - name: Move over release docs and stubs
+        run: |
+          rm -rf doc-branch/docs/develop/
+          cp -r doc-branch/docs/* ./docs/
+          touch ./docs/.nojekyll
+          touch ./docs/develop/.nojekyll
+          rm -rf doc-branch
+
+      - name: Commit files and push
+        run: |
+          git config --local user.email "spartee@hpe.com"
+          git config --local user.name "Sam Partee"
+          git checkout -b doc
+          git add .
+          git commit -m "Update develop documentation"
+          git push -f origin doc
+

Makefile

@@ -90,12 +90,30 @@ check-lint:
 docs:
 	@cd doc; make html
 
+# help: docks                          - generate project documentation with docker
+.PHONY: docks
+docks:
+	@if [ -d "docs" ]; then rm -rf docs; fi
+	@mkdir -p docs
+	@docker compose build docs-dev
+	@docker create -ti --name devdocs smartsim-docs:dev-latest
+	@docker cp devdocs:/usr/local/src/SmartSim/doc/_build/html/ ./docs/develop/
+	@docker container rm devdocs
+
 # help: cov                            - generate html coverage report for Python client
 .PHONY: cov
 cov:
 	@coverage html
 	@echo if data was present, coverage report is in ./htmlcov/index.html
 
+
+# help: tutorials-dev                  - Build and start a docker container to run the tutorials
+.PHONY: tutorials-dev
+tutorials-dev:
+	@docker compose build tutorials
+	@docker run -p 8888:8888 smartsim-tutorials:dev-latest
+
+
 # help:
 # help: Test
 # help: -------
@@ -126,5 +144,3 @@ test-cov:
 .PHONY: test-full
 test-full:
 	@python -m pytest --cov=./smartsim -vv --cov-config=${COV_FILE}
-
-