Skip to content

Commit 2aca305

Browse files
committed
Merge branch 'main' into pr-scipy
2 parents 34f59ae + ccb62c4 commit 2aca305

3 files changed

Lines changed: 21 additions & 33 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,6 @@ through and explain.
4848
- [ ] Public-facing APIs have Doxygen docs.
4949
- [ ] User-visible behavior changes have public docs, or a follow-up is
5050
tracked.
51-
- [ ] User-facing docs for new features are in a **separate PR** held until
52-
release (the docs site publishes immediately on merge to the default
53-
branch, so feature docs must not land before the feature ships).
5451

5552
### Code style
5653
- [ ] Naming follows the existing convention (`snake_case` vs `camelCase`) for

.github/workflows/docs.yaml

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -113,23 +113,24 @@ jobs:
113113
with:
114114
path: build/docs/build/
115115

116-
deploy:
117-
name: Deploy latest docs
118-
if: |
119-
github.ref == 'refs/heads/main' &&
120-
(
121-
github.event_name == 'push' ||
122-
inputs.deploy_docs == true
123-
)
124-
environment:
125-
name: github-pages
126-
url: ${{ steps.deployment.outputs.page_url }}
127-
runs-on: ubuntu-latest
128-
permissions:
129-
pages: write
130-
id-token: write
131-
needs: build
132-
steps:
133-
- name: Deploy to GitHub Pages
134-
id: deployment
135-
uses: actions/deploy-pages@v4
116+
# Disable for now, re-enable closer to release.
117+
# deploy:
118+
# name: Deploy latest docs
119+
# if: |
120+
# github.ref == 'refs/heads/main' &&
121+
# (
122+
# github.event_name == 'push' ||
123+
# inputs.deploy_docs == true
124+
# )
125+
# environment:
126+
# name: github-pages
127+
# url: ${{ steps.deployment.outputs.page_url }}
128+
# runs-on: ubuntu-latest
129+
# permissions:
130+
# pages: write
131+
# id-token: write
132+
# needs: build
133+
# steps:
134+
# - name: Deploy to GitHub Pages
135+
# id: deployment
136+
# uses: actions/deploy-pages@v4

Contributing.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -85,16 +85,6 @@ this section is the authoritative source.
8585
required.
8686
- If public docs were not created for a user-visible change, **report and track
8787
that they still need to be written.**
88-
- **Docs for new features go in a separate PR, held until release.** Our
89-
published documentation site updates immediately when changes land on the
90-
default branch, so user-facing docs that describe a feature must not be
91-
merged before the feature is actually available in a release. The
92-
recommended flow is:
93-
1. Merge the code change (with Doxygen / API reference updates only).
94-
2. Open a follow-up PR that adds the user-facing docs (guides, tutorials,
95-
release notes, examples).
96-
3. Keep that docs PR in Draft / on hold and merge it at release time so
97-
the published site and the released bits go live together.
9888

9989
### Code style
10090

0 commit comments

Comments
 (0)