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.

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

[DOC] fix the docs local build failure due to corrupt notebook #6426

Merged
merged 3 commits into from
May 16, 2024

Conversation

fnhirwa
Copy link
Member

@fnhirwa fnhirwa commented May 15, 2024

Reference Issues/PRs

Fixes #6425

What does this implement/fix? Explain your changes.

This PR resolves the issue that was being rose when trying to build docs locally. As was shared on Discord

Notebook error:
JSONDecodeError in examples/00_sktime_intro.ipynb:
Expecting value: line 1 column 1 (char 0)
make: *** [html] Error 2

After deep inspection, the issue was the notebook that had extra characters that weren't recognized by JSON decoder.
I added a fixed file and successfully tested the docs build locally from my environment.

Does your contribution introduce a new dependency? If yes, which one?

What should a reviewer concentrate their feedback on?

Did you add any tests for the change?

Any other comments?

PR checklist

For all contributions
  • I've added myself to the list of contributors with any new badges I've earned :-)
    How to: add yourself to the all-contributors file in the sktime root directory (not the CONTRIBUTORS.md). Common badges: code - fixing a bug, or adding code logic. doc - writing or improving documentation or docstrings. bug - reporting or diagnosing a bug (get this plus code if you also fixed the bug in the PR).maintenance - CI, test framework, release.
    See here for full badge reference
  • Optionally, for added estimators: I've added myself and possibly to the maintainers tag - do this if you want to become the owner or maintainer of an estimator you added.
    See here for further details on the algorithm maintainer role.
  • The PR title starts with either [ENH], [MNT], [DOC], or [BUG]. [BUG] - bugfix, [MNT] - CI, test framework, [ENH] - adding or improving code, [DOC] - writing or improving documentation or docstrings.
For new estimators
  • I've added the estimator to the API reference - in docs/source/api_reference/taskname.rst, follow the pattern.
  • I've added one or more illustrative usage examples to the docstring, in a pydocstyle compliant Examples section.
  • If the estimator relies on a soft dependency, I've set the python_dependencies tag and ensured
    dependency isolation, see the estimator dependencies guide.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@fnhirwa fnhirwa marked this pull request as ready for review May 15, 2024 21:28
@fkiraly fkiraly added documentation Documentation & tutorials maintenance Continuous integration, unit testing & package distribution bugfix Fixes a known bug or removes unintended behavior labels May 15, 2024
fkiraly
fkiraly previously approved these changes May 15, 2024
Copy link
Collaborator

@fkiraly fkiraly left a comment

Choose a reason for hiding this comment

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

That's a bit odd, especially since the CI seemed fine - but thanks for hunting this down.

On a minor side note, could you kindly set the random seed in the initial train/test split, so re-executions of this notebook will not overwrite large parts of it, in the future?

a
dd a random seed
@fkiraly fkiraly changed the title [DOCS] fix the docs local build issue due to corupt notebook [DOC] fix the docs local build failure due to corrupt notebook May 16, 2024
@fkiraly fkiraly merged commit 70748d7 into sktime:main May 16, 2024
17 checks passed
@fnhirwa fnhirwa deleted the docs branch June 24, 2024 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix Fixes a known bug or removes unintended behavior documentation Documentation & tutorials maintenance Continuous integration, unit testing & package distribution
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Building docs locally failing due to a corrupt notebook
2 participants