fix: resolve develop docs 404 and address unresolved PR #71 review comments by Copilot · Pull Request #72 · RussellSB/pytrendy

Copilot · 2026-03-29T21:08:38Z

peaceiris/actions-gh-pages pushes to gh-pages but does not auto-enable GitHub Pages — the site never serves without a one-time manual step in Settings. Additionally, the check logic only inspected the last commit and the HEAD~1..HEAD diff, silently skipping deployment on multi-commit pushes.

`docs.yaml`

Added comment at the top of the file documenting the required one-time repo setting:

Settings → Pages → Source → Deploy from a branch → gh-pages / / (root)
fetch-depth: 2 → fetch-depth: 0 in check-should-deploy so the full history is available for push-range diffs
Replaced single-commit check (git log -1 + HEAD~1..HEAD) with full push-range logic: reads all commit messages from $GITHUB_EVENT_PATH and diffs before..sha, falling back to HEAD~1..HEAD only when before is all-zeros (first push to a branch)

`README.md`

Added pip install pytrendy snippet before the import block — the Quickstart was missing any install step
results.df → results.print_summary() — the code block and its output block were inconsistent; the shown output is from print_summary()

📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

- docs.yaml: change fetch-depth to 0 in check-should-deploy job - docs.yaml: replace git log -1 / HEAD~1..HEAD with full push-range check using GITHUB_EVENT_PATH (all commit messages + before..sha diff) - docs.yaml: add comment explaining the one-time GitHub Pages settings step - README.md: add pip install pytrendy snippet before the import block - README.md: fix results.df -> results.print_summary() to match shown output Agent-Logs-Url: https://github.com/RussellSB/pytrendy/sessions/dfaa5327-6e14-41a2-9982-dec2705766e7 Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com>

codecov · 2026-03-29T21:23:45Z

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

* ci: add develop branch pre-release pipeline for PyPI dev versions (#62) * fix: test prerelease versioning on develop (#63) * fix: add main as base branch in dev release config (#64) * chore: updating GIFs and README references (#66) * docs: finish tutorial pages on fundamentals (#70) * chore: adding mkdocs dependancies to pyproject.toml * chore: updating mkdocs yaml plugins so can be ran with latest updated package versions * chore: adding site to gitignore, so mkdocs doesnt try to git add local site assets when unintended * chore: reverting mkdocs yaml to not break __init__ method header comments from displaying * chore(docs): improve the syntax of dict arguments * chore: deleting old documentation pages that will become outdated * chore(docs): rephrasing home page to be more punchy * chore(docs): making more punchy * chore(docs): removing old files * chore(docs): updating structure * chore(docs): removing user guide * docs: moving installation and simple quickstart to homepage * docs: adding example gallery page, similar to pymc-marketing docs * chore(docs): rewording example gallery intro * chore(docs): slight rewording for example gallery and captions * chore: updating docs version requirements to be explicit otherwise conflicts * chore: updating GIF references * chore: tweaking padding * chore: removing next steps section from homepage * chore: removing old quick start * chore: removing old tutorial pages * chore(docs): moving why pytrendy to top * chore(invalid): attempting to use mkdocs-jupyter but conflicts with api-autonav * chore(fix): switching to mkdocs-jupyterlite does the trick * docs: customising jupyterlite css to harmonise better with the material theme look and feel * chore: update toml with jupyterlite * chore: improve css layout of Example Gallery * docs: updating link html for docs, referencing other pages appropriately * docs: adjust links in io __int__ * docs: found outdated spec * docs: added spinner on interactive notebook page load * chore: fixing pop up block that got conflicted with new logic * chore: removing H1 artifact from tutorial notebooks * chore: organising nav a bit better * chore: make fundamentals expand on default * chore: fixing hrefs in docs * docs: adding base documentation with code cell runs * docs: add detect gradual tutorial * docs: adding abrupt tutorial, and fixing minor typos in gradual tutorial * chore: minor refactoring of cells * chore: updating GIFs and README references (#66) * chore: update gradual tutorial * docs: adding noise tutorial * chore: docs polish and file restructure * chore: fix typo in gradual tutorial * chore: improving markdown cells wording in tutorials * chore: fix typos in docs * chore: final docs polish * chore(docs): enabling scroll handler table of contents through javascript workaround * chore(docs): fixing the comma line break issue of jupyterlite, adding a script workaround to rerun everytime that notebooks are updated. * chore: updating GIFs and README references (#66) * chore: delete old quickstart file * ci: deploy docs via GitHub pages (#71) * chore: delete outdated quickstart in docs * chore: update quickstart to be in synch with latest doc update * ci: adding new docs workflow for deploying to github io docs page * chore: updating README to reference docs site * fix: resolve develop docs 404 and address unresolved PR #71 review comments (#72) * Initial plan * fix: address unresolved PR #71 review comments and docs 404 issue - docs.yaml: change fetch-depth to 0 in check-should-deploy job - docs.yaml: replace git log -1 / HEAD~1..HEAD with full push-range check using GITHUB_EVENT_PATH (all commit messages + before..sha diff) - docs.yaml: add comment explaining the one-time GitHub Pages settings step - README.md: add pip install pytrendy snippet before the import block - README.md: fix results.df -> results.print_summary() to match shown output Agent-Logs-Url: https://github.com/RussellSB/pytrendy/sessions/dfaa5327-6e14-41a2-9982-dec2705766e7 Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com> * docs: add develop main indicator (#73) * docs: adding dev/main button switch * chore: auto-expanding the API reference pytrendy * docs(fix): fixing docs issue with example gallery references, needs to be under fundamental and no html explicit (#74) --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>

* ci: deploy documentation site and improve ci/cd workflow structure (#75) * ci: add develop branch pre-release pipeline for PyPI dev versions (#62) * fix: test prerelease versioning on develop (#63) * fix: add main as base branch in dev release config (#64) * chore: updating GIFs and README references (#66) * docs: finish tutorial pages on fundamentals (#70) * chore: adding mkdocs dependancies to pyproject.toml * chore: updating mkdocs yaml plugins so can be ran with latest updated package versions * chore: adding site to gitignore, so mkdocs doesnt try to git add local site assets when unintended * chore: reverting mkdocs yaml to not break __init__ method header comments from displaying * chore(docs): improve the syntax of dict arguments * chore: deleting old documentation pages that will become outdated * chore(docs): rephrasing home page to be more punchy * chore(docs): making more punchy * chore(docs): removing old files * chore(docs): updating structure * chore(docs): removing user guide * docs: moving installation and simple quickstart to homepage * docs: adding example gallery page, similar to pymc-marketing docs * chore(docs): rewording example gallery intro * chore(docs): slight rewording for example gallery and captions * chore: updating docs version requirements to be explicit otherwise conflicts * chore: updating GIF references * chore: tweaking padding * chore: removing next steps section from homepage * chore: removing old quick start * chore: removing old tutorial pages * chore(docs): moving why pytrendy to top * chore(invalid): attempting to use mkdocs-jupyter but conflicts with api-autonav * chore(fix): switching to mkdocs-jupyterlite does the trick * docs: customising jupyterlite css to harmonise better with the material theme look and feel * chore: update toml with jupyterlite * chore: improve css layout of Example Gallery * docs: updating link html for docs, referencing other pages appropriately * docs: adjust links in io __int__ * docs: found outdated spec * docs: added spinner on interactive notebook page load * chore: fixing pop up block that got conflicted with new logic * chore: removing H1 artifact from tutorial notebooks * chore: organising nav a bit better * chore: make fundamentals expand on default * chore: fixing hrefs in docs * docs: adding base documentation with code cell runs * docs: add detect gradual tutorial * docs: adding abrupt tutorial, and fixing minor typos in gradual tutorial * chore: minor refactoring of cells * chore: updating GIFs and README references (#66) * chore: update gradual tutorial * docs: adding noise tutorial * chore: docs polish and file restructure * chore: fix typo in gradual tutorial * chore: improving markdown cells wording in tutorials * chore: fix typos in docs * chore: final docs polish * chore(docs): enabling scroll handler table of contents through javascript workaround * chore(docs): fixing the comma line break issue of jupyterlite, adding a script workaround to rerun everytime that notebooks are updated. * chore: updating GIFs and README references (#66) * chore: delete old quickstart file * ci: deploy docs via GitHub pages (#71) * chore: delete outdated quickstart in docs * chore: update quickstart to be in synch with latest doc update * ci: adding new docs workflow for deploying to github io docs page * chore: updating README to reference docs site * fix: resolve develop docs 404 and address unresolved PR #71 review comments (#72) * Initial plan * fix: address unresolved PR #71 review comments and docs 404 issue - docs.yaml: change fetch-depth to 0 in check-should-deploy job - docs.yaml: replace git log -1 / HEAD~1..HEAD with full push-range check using GITHUB_EVENT_PATH (all commit messages + before..sha diff) - docs.yaml: add comment explaining the one-time GitHub Pages settings step - README.md: add pip install pytrendy snippet before the import block - README.md: fix results.df -> results.print_summary() to match shown output Agent-Logs-Url: https://github.com/RussellSB/pytrendy/sessions/dfaa5327-6e14-41a2-9982-dec2705766e7 Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com> * docs: add develop main indicator (#73) * docs: adding dev/main button switch * chore: auto-expanding the API reference pytrendy * docs(fix): fixing docs issue with example gallery references, needs to be under fundamental and no html explicit (#74) --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> * docs: fixing dev overlap UI bug on mobile by max width special case properties * docs: fixing url specs in docstrings for auto api nav * docs: fixing examples gallery margin padding on mobile, now even from both sides --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>

* ci: add develop branch pre-release pipeline for PyPI dev versions (#62) * fix: test prerelease versioning on develop (#63) * fix: add main as base branch in dev release config (#64) * chore: updating GIFs and README references (#66) * docs: finish tutorial pages on fundamentals (#70) * chore: adding mkdocs dependancies to pyproject.toml * chore: updating mkdocs yaml plugins so can be ran with latest updated package versions * chore: adding site to gitignore, so mkdocs doesnt try to git add local site assets when unintended * chore: reverting mkdocs yaml to not break __init__ method header comments from displaying * chore(docs): improve the syntax of dict arguments * chore: deleting old documentation pages that will become outdated * chore(docs): rephrasing home page to be more punchy * chore(docs): making more punchy * chore(docs): removing old files * chore(docs): updating structure * chore(docs): removing user guide * docs: moving installation and simple quickstart to homepage * docs: adding example gallery page, similar to pymc-marketing docs * chore(docs): rewording example gallery intro * chore(docs): slight rewording for example gallery and captions * chore: updating docs version requirements to be explicit otherwise conflicts * chore: updating GIF references * chore: tweaking padding * chore: removing next steps section from homepage * chore: removing old quick start * chore: removing old tutorial pages * chore(docs): moving why pytrendy to top * chore(invalid): attempting to use mkdocs-jupyter but conflicts with api-autonav * chore(fix): switching to mkdocs-jupyterlite does the trick * docs: customising jupyterlite css to harmonise better with the material theme look and feel * chore: update toml with jupyterlite * chore: improve css layout of Example Gallery * docs: updating link html for docs, referencing other pages appropriately * docs: adjust links in io __int__ * docs: found outdated spec * docs: added spinner on interactive notebook page load * chore: fixing pop up block that got conflicted with new logic * chore: removing H1 artifact from tutorial notebooks * chore: organising nav a bit better * chore: make fundamentals expand on default * chore: fixing hrefs in docs * docs: adding base documentation with code cell runs * docs: add detect gradual tutorial * docs: adding abrupt tutorial, and fixing minor typos in gradual tutorial * chore: minor refactoring of cells * chore: updating GIFs and README references (#66) * chore: update gradual tutorial * docs: adding noise tutorial * chore: docs polish and file restructure * chore: fix typo in gradual tutorial * chore: improving markdown cells wording in tutorials * chore: fix typos in docs * chore: final docs polish * chore(docs): enabling scroll handler table of contents through javascript workaround * chore(docs): fixing the comma line break issue of jupyterlite, adding a script workaround to rerun everytime that notebooks are updated. * chore: updating GIFs and README references (#66) * chore: delete old quickstart file * ci: deploy docs via GitHub pages (#71) * chore: delete outdated quickstart in docs * chore: update quickstart to be in synch with latest doc update * ci: adding new docs workflow for deploying to github io docs page * chore: updating README to reference docs site * fix: resolve develop docs 404 and address unresolved PR #71 review comments (#72) * Initial plan * fix: address unresolved PR #71 review comments and docs 404 issue - docs.yaml: change fetch-depth to 0 in check-should-deploy job - docs.yaml: replace git log -1 / HEAD~1..HEAD with full push-range check using GITHUB_EVENT_PATH (all commit messages + before..sha diff) - docs.yaml: add comment explaining the one-time GitHub Pages settings step - README.md: add pip install pytrendy snippet before the import block - README.md: fix results.df -> results.print_summary() to match shown output Agent-Logs-Url: https://github.com/RussellSB/pytrendy/sessions/dfaa5327-6e14-41a2-9982-dec2705766e7 Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com> * docs: add develop main indicator (#73) * docs: adding dev/main button switch * chore: auto-expanding the API reference pytrendy * docs(fix): fixing docs issue with example gallery references, needs to be under fundamental and no html explicit (#74) * docs: hot fixes on deployed docs UI for mobile-compatibiliy (#78) * ci: deploy documentation site and improve ci/cd workflow structure (#75) * ci: add develop branch pre-release pipeline for PyPI dev versions (#62) * fix: test prerelease versioning on develop (#63) * fix: add main as base branch in dev release config (#64) * chore: updating GIFs and README references (#66) * docs: finish tutorial pages on fundamentals (#70) * chore: adding mkdocs dependancies to pyproject.toml * chore: updating mkdocs yaml plugins so can be ran with latest updated package versions * chore: adding site to gitignore, so mkdocs doesnt try to git add local site assets when unintended * chore: reverting mkdocs yaml to not break __init__ method header comments from displaying * chore(docs): improve the syntax of dict arguments * chore: deleting old documentation pages that will become outdated * chore(docs): rephrasing home page to be more punchy * chore(docs): making more punchy * chore(docs): removing old files * chore(docs): updating structure * chore(docs): removing user guide * docs: moving installation and simple quickstart to homepage * docs: adding example gallery page, similar to pymc-marketing docs * chore(docs): rewording example gallery intro * chore(docs): slight rewording for example gallery and captions * chore: updating docs version requirements to be explicit otherwise conflicts * chore: updating GIF references * chore: tweaking padding * chore: removing next steps section from homepage * chore: removing old quick start * chore: removing old tutorial pages * chore(docs): moving why pytrendy to top * chore(invalid): attempting to use mkdocs-jupyter but conflicts with api-autonav * chore(fix): switching to mkdocs-jupyterlite does the trick * docs: customising jupyterlite css to harmonise better with the material theme look and feel * chore: update toml with jupyterlite * chore: improve css layout of Example Gallery * docs: updating link html for docs, referencing other pages appropriately * docs: adjust links in io __int__ * docs: found outdated spec * docs: added spinner on interactive notebook page load * chore: fixing pop up block that got conflicted with new logic * chore: removing H1 artifact from tutorial notebooks * chore: organising nav a bit better * chore: make fundamentals expand on default * chore: fixing hrefs in docs * docs: adding base documentation with code cell runs * docs: add detect gradual tutorial * docs: adding abrupt tutorial, and fixing minor typos in gradual tutorial * chore: minor refactoring of cells * chore: updating GIFs and README references (#66) * chore: update gradual tutorial * docs: adding noise tutorial * chore: docs polish and file restructure * chore: fix typo in gradual tutorial * chore: improving markdown cells wording in tutorials * chore: fix typos in docs * chore: final docs polish * chore(docs): enabling scroll handler table of contents through javascript workaround * chore(docs): fixing the comma line break issue of jupyterlite, adding a script workaround to rerun everytime that notebooks are updated. * chore: updating GIFs and README references (#66) * chore: delete old quickstart file * ci: deploy docs via GitHub pages (#71) * chore: delete outdated quickstart in docs * chore: update quickstart to be in synch with latest doc update * ci: adding new docs workflow for deploying to github io docs page * chore: updating README to reference docs site * fix: resolve develop docs 404 and address unresolved PR #71 review comments (#72) * Initial plan * fix: address unresolved PR #71 review comments and docs 404 issue - docs.yaml: change fetch-depth to 0 in check-should-deploy job - docs.yaml: replace git log -1 / HEAD~1..HEAD with full push-range check using GITHUB_EVENT_PATH (all commit messages + before..sha diff) - docs.yaml: add comment explaining the one-time GitHub Pages settings step - README.md: add pip install pytrendy snippet before the import block - README.md: fix results.df -> results.print_summary() to match shown output Agent-Logs-Url: https://github.com/RussellSB/pytrendy/sessions/dfaa5327-6e14-41a2-9982-dec2705766e7 Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com> * docs: add develop main indicator (#73) * docs: adding dev/main button switch * chore: auto-expanding the API reference pytrendy * docs(fix): fixing docs issue with example gallery references, needs to be under fundamental and no html explicit (#74) --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> * docs: fixing dev overlap UI bug on mobile by max width special case properties * docs: fixing url specs in docstrings for auto api nav * docs: fixing examples gallery margin padding on mobile, now even from both sides --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>

Initial plan

3abec36

Copilot AI assigned Copilot and RussellSB Mar 29, 2026

Copilot started work on behalf of RussellSB March 29, 2026 21:08 View session

Copilot AI changed the title ~~[WIP] Investigate deployment issue for open source package docs~~ fix: resolve develop docs 404 and address unresolved PR #71 review comments Mar 29, 2026

Copilot finished work on behalf of RussellSB March 29, 2026 21:14

Copilot AI requested a review from RussellSB March 29, 2026 21:14

RussellSB approved these changes Mar 29, 2026

View reviewed changes

RussellSB marked this pull request as ready for review March 29, 2026 21:22

RussellSB merged commit cacabdf into develop Mar 29, 2026
2 checks passed

RussellSB deleted the copilot/investigate-docs-deployment-issue branch March 29, 2026 21:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: resolve develop docs 404 and address unresolved PR #71 review comments#72

fix: resolve develop docs 404 and address unresolved PR #71 review comments#72
RussellSB merged 2 commits intodevelopfrom
copilot/investigate-docs-deployment-issue

Copilot AI commented Mar 29, 2026 •

edited

Loading

Uh oh!

codecov bot commented Mar 29, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Copilot AI commented Mar 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

docs.yaml

README.md

Uh oh!

codecov bot commented Mar 29, 2026

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Mar 29, 2026 •

edited

Loading

`docs.yaml`

`README.md`