use quarto project profiles

isabelizimm · isabelizimm · commit a6b83aae0105 · 2023-02-14T09:37:39.000-05:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -25,26 +25,30 @@ jobs:
         uses: quarto-dev/quarto-actions/setup@v2
       - name: build docs
         run: |
-          make docs
+          make docs-latest
       - name: save docs
         uses: actions/upload-artifact@v3
         with:
           name: docs-html
           path: docs/_site/
+      - name: publish dev docs
+        if: github.ref_name == 'main' && github.ref_type == 'branch'
+        run: |
+          make docs-
       - name: publish dev docs
         if: github.ref_name == 'main' && github.ref_type == 'branch'
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/_site/*
+          publish_dir: docs/latest/*
           publish_branch: gh-pages
           destination_dir: main
       - name: publish stable docs
         if: github.ref_type == 'tag' && startswith(github.ref, 'refs/tags/v')
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/_site/*
+          publish_dir: docs/stable/*
           publish_branch: gh-pages
           destination_dir: ${{ github.ref_name }}
       - name: create symlink stable to new version
diff --git a/Makefile b/Makefile
@@ -60,8 +60,13 @@ coverage:
 	coverage html
 	$(BROWSER) htmlcov/index.html
 
-docs doc documentation:
-	$(MAKE) -C docs clean
+docs doc documentation: docs-latest docs-stable
+
+docs-latest:
+	$(MAKE) -C docs latest
+
+docs-stable:
+	$(MAKE) -C docs stable
 
 release: dist
 	twine upload dist/*
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -3,3 +3,5 @@
 /objects.json
 /_sidebar.yml
 /reference
+/latest
+/stable
diff --git a/docs/Makefile b/docs/Makefile
@@ -1,9 +1,19 @@
 # Minimal makefile for quartodoc documentation
 
-.PHONY: help Makefile
+.PHONY: help Makefile stable latest
 
 # Catch-all target:
 %: Makefile
+
+
+latest:
+	python version_config.py
+	python -m quartodoc build
+	python -m quartodoc interlinks
+	quarto render --profile latest
+
+stable:
+	python version_config.py
 	python -m quartodoc build
 	python -m quartodoc interlinks
 	quarto render
diff --git a/docs/_environment b/docs/_environment
@@ -0,0 +1,2 @@
+LATEST=0.2.0.post10+g578f644.d20230213
+STABLE=0.2.0
diff --git a/docs/_quarto-latest.yml b/docs/_quarto-latest.yml
@@ -0,0 +1,3 @@
+project:
+  title: "Vetiver {{< env VERSION >}}"
+  output-dir: stable
diff --git a/docs/_quarto-stable.yml b/docs/_quarto-stable.yml
@@ -0,0 +1,3 @@
+project:
+  title: "Vetiver {{< env VERSION >}}"
+  output-dir: stable
diff --git a/docs/_quarto.yml b/docs/_quarto.yml
@@ -1,9 +1,9 @@
 project:
   type: website
-  output-dir: _site
+  pre-render: prepare.py
 
 website:
-  title: "Vetiver for Python"
+  title: "Vetiver {{< env VERSION >}}"
   description: "Version, share, deploy, and monitor your Python models"
   repo-url: https://github.com/rstudio/vetiver-python
   repo-actions: [edit, issue]
@@ -76,10 +76,6 @@ quartodoc:
         - StatsmodelsHandler
         - XGBoostHandler
 
-    # - title: "Advanced Usage"
-    #   contents:
-    #
-
 metadata-files:
   - _sidebar.yml
 
@@ -89,6 +85,9 @@ filters:
 interlinks:
   sources: {}
 
+profile:
+  default: latest
+
 format:
   html:
     theme: sandstone
diff --git a/docs/version_config.py b/docs/version_config.py
@@ -0,0 +1,6 @@
+from importlib_metadata import version as _version
+
+v = f"""VERSION={_version('vetiver')}"""
+
+f = open("_environment", "w")
+f.write(v)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+LATEST=0.2.0.post10+g578f644.d20230213`
	`2`	`+STABLE=0.2.0`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+project:`
	`2`	`+ title: "Vetiver {{< env VERSION >}}"`
	`3`	`+ output-dir: stable`