@@ -47,7 +47,7 @@ conda and the `Makefile` to run the tests and checks.
47
47
48
48
### GitHub Actions
49
49
50
- There are 6 configuration files located in ` .github/workflows ` :
50
+ There are 5 configuration files located in ` .github/workflows ` :
51
51
52
52
1 . ` style_checks.yaml ` (Code lint and style checks)
53
53
@@ -84,19 +84,16 @@ This workflow is ran to publish wheels to PyPI and TestPyPI (for testing only).
84
84
Archives will be pushed to TestPyPI on every commit to the * master* branch and
85
85
tagged releases, and to PyPI for tagged releases only.
86
86
87
- 6 . ` continuous-documentation.yml ` (Deploy documentation to Vercel for preview)
88
-
89
- This workflow builds and deploys the documentation in Pull Requests to Vercel,
90
- to make it easier to preview documentation changes.
91
87
92
88
## Continuous Documentation
93
89
94
- We use a cloud platform service called [ Vercel] ( https://vercel.com/ ) via
95
- [ vercel-action] ( https://github.com/marketplace/actions/vercel-action ) to
96
- preview changes made to our documentation website every time we make a commit
97
- in a pull request. The workflow ` continuous-documentation.yml ` builds and
98
- deploys the documentation to Vercel. The vercel bot will automatically make a
99
- comment with a URL to preview the deployed documentation for that pull request.
90
+ We use the [ Vercel for GitHub] ( https://github.com/apps/vercel ) App to preview changes
91
+ made to our documentation website every time we make a commit in a pull request.
92
+ The service has a configuration file ` vercel.json ` , with a list of options to
93
+ change the default behaviour at https://vercel.com/docs/configuration .
94
+ The actual script ` package.json ` is used by Vercel to install the necessary packages,
95
+ build the documentation, copy the files to a 'public' folder and deploy that to the web,
96
+ see https://vercel.com/docs/build-step .
100
97
101
98
## Making a Release
102
99
0 commit comments