diff --git a/last_commit.txt b/last_commit.txt index 04f8f1d066..ed73d0e802 100644 --- a/last_commit.txt +++ b/last_commit.txt @@ -1,144 +1,16 @@ -Repository: plone.api +Repository: plonetheme.barceloneta -Branch: refs/heads/main -Date: 2024-12-17T02:44:46-08:00 -Author: Steve Piercy (stevepiercy) -Commit: https://github.com/plone/plone.api/commit/ee2ee4321890231a9e6af942bb5653797349f772 +Branch: refs/heads/3.1.x +Date: 2024-09-03T11:14:47+02:00 +Author: Peter Mathis (petschki) +Commit: https://github.com/plone/plonetheme.barceloneta/commit/1bcb9083006886626b47e69abe12b1bb156f7e9f -Use Read the Docs for pull request previews +3.1.10 Files changed: -A .github/workflows/rtd-pr-preview.yml -A .readthedocs.yaml +M package-lock.json +M package.json -b'diff --git a/.github/workflows/rtd-pr-preview.yml b/.github/workflows/rtd-pr-preview.yml\nnew file mode 100644\nindex 00000000..b1be1f5f\n--- /dev/null\n+++ b/.github/workflows/rtd-pr-preview.yml\n@@ -0,0 +1,22 @@\n+# .github/workflows/rtd-pr-preview.yml\n+name: readthedocs/actions\n+on:\n+ pull_request_target:\n+ types:\n+ - opened\n+ # Execute this action only on PRs that touch\n+ # documentation files.\n+ # paths:\n+ # - "docs/**"\n+\n+permissions:\n+ pull-requests: write\n+\n+jobs:\n+ documentation-links:\n+ runs-on: ubuntu-latest\n+ steps:\n+ - uses: readthedocs/actions/preview@v1\n+ with:\n+ project-slug: "ploneapi"\n+ single-version: "true"\ndiff --git a/.readthedocs.yaml b/.readthedocs.yaml\nnew file mode 100644\nindex 00000000..f32a2278\n--- /dev/null\n+++ b/.readthedocs.yaml\n@@ -0,0 +1,25 @@\n+# .readthedocs.yaml\n+# Read the Docs configuration file\n+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details\n+\n+# Required\n+version: 2\n+\n+# Set the OS, Python version and other tools you might need\n+build:\n+ os: ubuntu-22.04\n+ tools:\n+ python: "3.12"\n+ commands:\n+ # Cancel building pull requests when there aren\'t changes in the docs directory or YAML file.\n+ # You can add any other files or directories that you\'d like here as well,\n+ # like your docs requirements file, or other files that will change your docs build.\n+ #\n+ # If there are no changes (git diff exits with 0) we force the command to return with 183.\n+ # This is a special exit code on Read the Docs that will cancel the build immediately.\n+ - |\n+ if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/ .readthedocs.yaml requirements-docs.txt requirements.txt;\n+ then\n+ exit 183;\n+ fi\n+ - tox -e plone6docs\n' - -Repository: plone.api - - -Branch: refs/heads/main -Date: 2024-12-17T03:01:55-08:00 -Author: Steve Piercy (stevepiercy) -Commit: https://github.com/plone/plone.api/commit/1a02f35c0f26fa43f88414ca5a75d3468a9c9297 - -Fiddle with commands to RTD - -Files changed: -M .readthedocs.yaml - -b'diff --git a/.readthedocs.yaml b/.readthedocs.yaml\nindex f32a2278..c9cbccd4 100644\n--- a/.readthedocs.yaml\n+++ b/.readthedocs.yaml\n@@ -22,4 +22,6 @@ build:\n then\n exit 183;\n fi\n+ - pip install -r requirements.txt\n+ - pip install -r requirements-docs.txt\n - tox -e plone6docs\n' - -Repository: plone.api - - -Branch: refs/heads/main -Date: 2024-12-17T03:03:57-08:00 -Author: Steve Piercy (stevepiercy) -Commit: https://github.com/plone/plone.api/commit/c1e063bd5379d4d8eba71eb79b610a836e5c1f6e - -Drop to Python 3.11 because plone.api does not yet officially support 3.12 - -Files changed: -M .readthedocs.yaml - -b'diff --git a/.readthedocs.yaml b/.readthedocs.yaml\nindex c9cbccd4..f985ae36 100644\n--- a/.readthedocs.yaml\n+++ b/.readthedocs.yaml\n@@ -9,7 +9,7 @@ version: 2\n build:\n os: ubuntu-22.04\n tools:\n- python: "3.12"\n+ python: "3.11"\n commands:\n # Cancel building pull requests when there aren\'t changes in the docs directory or YAML file.\n # You can add any other files or directories that you\'d like here as well,\n' - -Repository: plone.api - - -Branch: refs/heads/main -Date: 2024-12-17T03:18:02-08:00 -Author: Steve Piercy (stevepiercy) -Commit: https://github.com/plone/plone.api/commit/975c810969e92a3478144c7521632e7f3c838f33 - -Specify where to put built files on RTD - -Files changed: -M .readthedocs.yaml -M tox.ini - -b'diff --git a/.readthedocs.yaml b/.readthedocs.yaml\nindex f985ae36..38273c59 100644\n--- a/.readthedocs.yaml\n+++ b/.readthedocs.yaml\n@@ -23,5 +23,5 @@ build:\n exit 183;\n fi\n - pip install -r requirements.txt\n- - pip install -r requirements-docs.txt\n- - tox -e plone6docs\n+# - pip install -r requirements-docs.txt\n+ - tox -e rtd-preview\ndiff --git a/tox.ini b/tox.ini\nindex cc85d042..07c89024 100644\n--- a/tox.ini\n+++ b/tox.ini\n@@ -271,6 +271,23 @@ commands =\n mkdir -p {toxinidir}/_build/plone6docs\n sphinx-build -b html -d _build/plone6docs/doctrees docs _build/plone6docs/html\n \n+[testenv:rtd-preview]\n+# New docs with sphinx-book-theme\n+# See [testenv:docs] for classic documentation\n+basepython = python3.11\n+skip_install = False\n+package = editable\n+allowlist_externals =\n+ mkdir\n+extras =\n+ tests\n+deps =\n+ -r requirements-docs.txt\n+commands =\n+ python -VV\n+ mkdir -p {toxinidir}/${READTHEDOCS_OUTPUT}\n+ sphinx-build -b html -d ${READTHEDOCS_OUTPUT}/doctrees/ docs ${READTHEDOCS_OUTPUT}/html/\n+\n [testenv:docs]\n basepython = python3.9\n skip_install = False\n' - -Repository: plone.api - - -Branch: refs/heads/main -Date: 2024-12-17T03:21:35-08:00 -Author: Steve Piercy (stevepiercy) -Commit: https://github.com/plone/plone.api/commit/dce02cf0f697d71f2edad6b179bd209bb384eaaa - -Fiddle with tox syntax - -Files changed: -M tox.ini - -b'diff --git a/tox.ini b/tox.ini\nindex 07c89024..3953cc06 100644\n--- a/tox.ini\n+++ b/tox.ini\n@@ -285,8 +285,8 @@ deps =\n -r requirements-docs.txt\n commands =\n python -VV\n- mkdir -p {toxinidir}/${READTHEDOCS_OUTPUT}\n- sphinx-build -b html -d ${READTHEDOCS_OUTPUT}/doctrees/ docs ${READTHEDOCS_OUTPUT}/html/\n+ mkdir -p {toxinidir}/$READTHEDOCS_OUTPUT\n+ sphinx-build -b html -d $READTHEDOCS_OUTPUT/doctrees/ docs $READTHEDOCS_OUTPUT/html/\n \n [testenv:docs]\n basepython = python3.9\n' - -Repository: plone.api - - -Branch: refs/heads/main -Date: 2024-12-17T03:32:11-08:00 -Author: Steve Piercy (stevepiercy) -Commit: https://github.com/plone/plone.api/commit/6d88ea717a5a071c5ced7353dd75bf50be3e705b - -Fiddle with tox syntax attempt 2 - -Files changed: -M tox.ini - -b'diff --git a/tox.ini b/tox.ini\nindex 3953cc06..b8c64bd9 100644\n--- a/tox.ini\n+++ b/tox.ini\n@@ -285,8 +285,7 @@ deps =\n -r requirements-docs.txt\n commands =\n python -VV\n- mkdir -p {toxinidir}/$READTHEDOCS_OUTPUT\n- sphinx-build -b html -d $READTHEDOCS_OUTPUT/doctrees/ docs $READTHEDOCS_OUTPUT/html/\n+ sphinx-build -b html -d "{env:READTHEDOCS_OUTPUT}"/doctrees/ docs "{env:READTHEDOCS_OUTPUT}"/html/"\n \n [testenv:docs]\n basepython = python3.9\n' - -Repository: plone.api - - -Branch: refs/heads/main -Date: 2024-12-17T03:35:13-08:00 -Author: Steve Piercy (stevepiercy) -Commit: https://github.com/plone/plone.api/commit/949a16a7180dadca7fb641ba375526e162b184e6 - -Fiddle with tox syntax attempt 3 - -Files changed: -M tox.ini - -b'diff --git a/tox.ini b/tox.ini\nindex b8c64bd9..eb6b27ae 100644\n--- a/tox.ini\n+++ b/tox.ini\n@@ -285,7 +285,7 @@ deps =\n -r requirements-docs.txt\n commands =\n python -VV\n- sphinx-build -b html -d "{env:READTHEDOCS_OUTPUT}"/doctrees/ docs "{env:READTHEDOCS_OUTPUT}"/html/"\n+ sphinx-build -b html -d "{env:READTHEDOCS_OUTPUT}"/doctrees/ docs "{env:READTHEDOCS_OUTPUT}"/html/\n \n [testenv:docs]\n basepython = python3.9\n' - -Repository: plone.api - - -Branch: refs/heads/main -Date: 2024-12-17T16:39:34-08:00 -Author: David Glick (davisagli) -Commit: https://github.com/plone/plone.api/commit/b5e510fe5124c3a99bb1f952a7e9d3413c5bd085 - -news and manifest - -Files changed: -A news/545.documentation -M MANIFEST.in - -b'diff --git a/MANIFEST.in b/MANIFEST.in\nindex 162a5ec9..c89b5bdb 100644\n--- a/MANIFEST.in\n+++ b/MANIFEST.in\n@@ -14,6 +14,7 @@ include pyproject.toml\n recursive-exclude news *\n exclude news\n recursive-exclude .vscode *\n+exclude .readthedocs.yaml\n \n # added by check-manifest\n recursive-include src *.py\ndiff --git a/news/545.documentation b/news/545.documentation\nnew file mode 100644\nindex 00000000..ac078ab0\n--- /dev/null\n+++ b/news/545.documentation\n@@ -0,0 +1 @@\n+Preview docs on Read the Docs instead of Netlify. @stevepiercy\n' - -Repository: plone.api - - -Branch: refs/heads/main -Date: 2024-12-17T16:47:20-08:00 -Author: David Glick (davisagli) -Commit: https://github.com/plone/plone.api/commit/d8c716bb820e2308d296431df013bf990058e3ac - -Merge pull request #545 from plone/rtd-preview - -Use Read the Docs for pull request previews - -Files changed: -A .github/workflows/rtd-pr-preview.yml -A .readthedocs.yaml -A news/545.documentation -M MANIFEST.in -M tox.ini - -b'diff --git a/.github/workflows/rtd-pr-preview.yml b/.github/workflows/rtd-pr-preview.yml\nnew file mode 100644\nindex 00000000..b1be1f5f\n--- /dev/null\n+++ b/.github/workflows/rtd-pr-preview.yml\n@@ -0,0 +1,22 @@\n+# .github/workflows/rtd-pr-preview.yml\n+name: readthedocs/actions\n+on:\n+ pull_request_target:\n+ types:\n+ - opened\n+ # Execute this action only on PRs that touch\n+ # documentation files.\n+ # paths:\n+ # - "docs/**"\n+\n+permissions:\n+ pull-requests: write\n+\n+jobs:\n+ documentation-links:\n+ runs-on: ubuntu-latest\n+ steps:\n+ - uses: readthedocs/actions/preview@v1\n+ with:\n+ project-slug: "ploneapi"\n+ single-version: "true"\ndiff --git a/.readthedocs.yaml b/.readthedocs.yaml\nnew file mode 100644\nindex 00000000..38273c59\n--- /dev/null\n+++ b/.readthedocs.yaml\n@@ -0,0 +1,27 @@\n+# .readthedocs.yaml\n+# Read the Docs configuration file\n+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details\n+\n+# Required\n+version: 2\n+\n+# Set the OS, Python version and other tools you might need\n+build:\n+ os: ubuntu-22.04\n+ tools:\n+ python: "3.11"\n+ commands:\n+ # Cancel building pull requests when there aren\'t changes in the docs directory or YAML file.\n+ # You can add any other files or directories that you\'d like here as well,\n+ # like your docs requirements file, or other files that will change your docs build.\n+ #\n+ # If there are no changes (git diff exits with 0) we force the command to return with 183.\n+ # This is a special exit code on Read the Docs that will cancel the build immediately.\n+ - |\n+ if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/ .readthedocs.yaml requirements-docs.txt requirements.txt;\n+ then\n+ exit 183;\n+ fi\n+ - pip install -r requirements.txt\n+# - pip install -r requirements-docs.txt\n+ - tox -e rtd-preview\ndiff --git a/MANIFEST.in b/MANIFEST.in\nindex 162a5ec9..c89b5bdb 100644\n--- a/MANIFEST.in\n+++ b/MANIFEST.in\n@@ -14,6 +14,7 @@ include pyproject.toml\n recursive-exclude news *\n exclude news\n recursive-exclude .vscode *\n+exclude .readthedocs.yaml\n \n # added by check-manifest\n recursive-include src *.py\ndiff --git a/news/545.documentation b/news/545.documentation\nnew file mode 100644\nindex 00000000..ac078ab0\n--- /dev/null\n+++ b/news/545.documentation\n@@ -0,0 +1 @@\n+Preview docs on Read the Docs instead of Netlify. @stevepiercy\ndiff --git a/tox.ini b/tox.ini\nindex cc85d042..eb6b27ae 100644\n--- a/tox.ini\n+++ b/tox.ini\n@@ -271,6 +271,22 @@ commands =\n mkdir -p {toxinidir}/_build/plone6docs\n sphinx-build -b html -d _build/plone6docs/doctrees docs _build/plone6docs/html\n \n+[testenv:rtd-preview]\n+# New docs with sphinx-book-theme\n+# See [testenv:docs] for classic documentation\n+basepython = python3.11\n+skip_install = False\n+package = editable\n+allowlist_externals =\n+ mkdir\n+extras =\n+ tests\n+deps =\n+ -r requirements-docs.txt\n+commands =\n+ python -VV\n+ sphinx-build -b html -d "{env:READTHEDOCS_OUTPUT}"/doctrees/ docs "{env:READTHEDOCS_OUTPUT}"/html/\n+\n [testenv:docs]\n basepython = python3.9\n skip_install = False\n' +b'diff --git a/package-lock.json b/package-lock.json\nindex 81741949..09c512a2 100644\n--- a/package-lock.json\n+++ b/package-lock.json\n@@ -1,12 +1,12 @@\n {\n "name": "@plone/plonetheme-barceloneta-base",\n- "version": "3.1.9",\n+ "version": "3.1.10",\n "lockfileVersion": 3,\n "requires": true,\n "packages": {\n "": {\n "name": "@plone/plonetheme-barceloneta-base",\n- "version": "3.1.9",\n+ "version": "3.1.10",\n "license": "MIT",\n "dependencies": {\n "bootstrap": "5.3.3"\ndiff --git a/package.json b/package.json\nindex 8f11b383..4c378e04 100644\n--- a/package.json\n+++ b/package.json\n@@ -1,7 +1,7 @@\n {\n "name": "@plone/plonetheme-barceloneta-base",\n "description": "Plone Theme Barceloneta Resources",\n- "version": "3.1.9",\n+ "version": "3.1.10",\n "files": [\n "/scss",\n "/plonetheme/barceloneta/theme/tinymce/*.css"\n'