docs: hot fixes on deployed docs UI for mobile-compatibiliy#78
Merged
docs: hot fixes on deployed docs UI for mobile-compatibiliy#78
Conversation
* 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>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
RussellSB
added a commit
that referenced
this pull request
Mar 31, 2026
* 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>
Owner
Author
|
For some reason the API reference fixed got overwritten before merging. Will need to do a hotfix on main and dev. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses points raised in issue #76 :
Footer was not flexible to adjust since its a part of the Material theme, ignoring for now