Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pin Sphinx version and make Netlify happy #1445

Closed
wants to merge 5 commits into from
Closed

Pin Sphinx version and make Netlify happy #1445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
934b081
Pin Sphinx version
ksuess Jun 9, 2022
d3569fd
Create 1445.bugfix
ksuess Jun 9, 2022
657547c
Update ignore for Netlify builds
ksuess Jun 9, 2022
4a4d11a
Merge branch 'master' into pin-sphinx-version
stevepiercy Aug 25, 2023
225593f
Merge branch 'master' into pin-sphinx-version
stevepiercy Aug 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,6 @@ def patch_pygments_to_highlight_jsonschema():
linkcheck_ignore = [
r"https://coveralls.io/repos/github/plone/plone.restapi/badge.svg\?branch=master", # plone.restapi
r"https://github.com/plone/plone.restapi/blob/dde57b88e0f1b5f5e9f04e6a21865bc0dde55b1c/src/plone/restapi/services/content/add.py#L35-L61", # plone.restapi
r"https://vhs-ehrenamtsportal.de/", # cert fix in progress
]


Expand Down
2 changes: 1 addition & 1 deletion netlify.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
PYTHON_VERSION = "3.8"

[build]
ignore = "git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF ./docs/"
ignore = "git diff --quiet $BRANCH $HEAD -- ./docs/source/"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comparing the changes on the branch. This has the effect, that the preview is done or at least kept, even when a further commit to the branch does not include any changes in /docs/source/.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Netlify log says fatal: bad revision 'pull/1445/head':

https://app.netlify.com/sites/plone-restapi/deploys/62a194ddac9c4d0008ab7e5a#L14

It still builds, so maybe it is OK? ¯\_(ツ)_/¯ Or perhaps it builds for every commit, and not only for changes in /docs/source? You can test by pushing two trivial commits, one with a change in /docs/source only, and one outside.

I also checked the Netlify logs, and it was building only for changes inside /docs/source/ up until this change. It's possible it was a one-time fluke.

While we're looking at this directory, can you delete /docs/requirements.txt? It has been replaced by /requirements-docs.txt.

1 change: 1 addition & 0 deletions news/1445.bugfix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Pin Sphinx version and make Netlify previewing happy. [ksuess, stevepiercy]