Clean up docs rules and add install-ci target

Author: schloerke

.github/py-shiny/setup/action.yaml

@@ -17,15 +17,10 @@ runs:
           # cache-dependency-path: |
           #   setup.cfg
 
-      - name: Upgrade pip
-        shell: bash
-        run: python -m pip install --upgrade pip
-
       - name: Install dependencies
         shell: bash
         run: |
-          pip install https://github.com/rstudio/py-htmltools/tarball/main
-          make install-deps
+          make install-ci
 
       - name: Install
         shell: bash

.github/workflows/build-docs.yaml

@@ -22,45 +22,29 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Upgrade pip
-        run: python -m pip install --upgrade pip
-
       - name: Install Quarto
         uses: quarto-dev/quarto-actions/setup@v2
         with:
           version: 1.3.340
 
-      - name: Install dependencies
-        run: |
-          cd docs
-          make ../venv
-          make deps
-
-      - name: Run quartodoc
-        run: |
-          cd docs
-          make quartodoc
-
       - name: Build site
         run: |
-          cd docs
-          make site
+          make docs
 
       - name: Upload site artifact
         if: github.ref == 'refs/heads/main'
         uses: actions/upload-pages-artifact@v1
         with:
           path: "docs/_site"
 
-
   deploy:
     if: github.ref == 'refs/heads/main'
     needs: build
 
     # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
     permissions:
-      pages: write      # to deploy to Pages
-      id-token: write   # to verify the deployment originates from an appropriate source
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
 
     # Deploy to the github-pages environment
     environment:

.github/workflows/pytest.yaml

@@ -195,9 +195,7 @@ jobs:
           python-version: "3.10"
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install https://github.com/rstudio/py-htmltools/tarball/main
-          make install-deps
+          make install-ci
           make install
       - name: "Build Package"
         run: |

Makefile

@@ -146,6 +146,11 @@ install-deps: $(UV) FORCE ## install dependencies
 	. $(PYBIN)/activate && \
 	  uv pip install -e ".[dev,test]" --refresh
 
+install-ci: $(UV) FORCE ## install dependencies for CI
+	. $(PYBIN)/activate && \
+	  uv pip install -e ".[dev,test]" --refresh \
+	  "htmltools @ git+https://github.com/posit-dev/py-htmltools.git"
+
 
 
 # ## If caching is ever used, we could run:
@@ -237,15 +242,23 @@ install-docs: $(UV) FORCE
 	  "htmltools @ git+https://github.com/posit-dev/py-htmltools.git" \
 	  "shinylive @ git+https://github.com/posit-dev/py-shinylive.git"
 
-docs: $(PYBIN) FORCE ## docs: build quartodoc docs
+docs: docs-serve FORCE ## docs: build and serve docs in browser
+
+docs-serve: $(PYBIN) FORCE ## docs: serve docs in browser
+	$(MAKE) docs-quartodoc
+	@echo "-------- Previewing docs in browser --------"
+	@cd docs && make serve
+
+docs-site: $(PYBIN) FORCE ## docs: render quarto site
+	$(MAKE) docs-quartodoc
+	@echo "-------- Previewing docs in browser --------"
+	@cd docs && make serve
+
+docs-quartodoc: $(PYBIN) FORCE ## docs: build quartodoc docs
 	$(MAKE) install-docs
 	@echo "-------- Building docs with quartodoc --------"
 	@cd docs && make quartodoc
 
-docs-preview: $(PYBIN) FORCE ## docs: preview docs in browser
-	$(MAKE) install-docs
-	@echo "-------- Previewing docs in browser --------"
-	@cd docs && make serve
 
 # -----------------
 # Testing with playwright