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] Building docs locally failing due to a corrupt notebook #6425

Closed
fnhirwa opened this issue May 15, 2024 · 0 comments · Fixed by #6426
Closed

[DOC] Building docs locally failing due to a corrupt notebook #6425

fnhirwa opened this issue May 15, 2024 · 0 comments · Fixed by #6426
Labels
documentation Documentation & tutorials

Comments

@fnhirwa
Copy link
Contributor

fnhirwa commented May 15, 2024

Describe the issue linked to the documentation

The issue is a notebook, examples/00_sktime_intro.ipynb that is corrupt and causing local docs building to fail.

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

System info:

System:
    python: 3.9.18 (CPython, Aug 24 2023 18:16:58, Clang 15.0.0 (clang-1500.1.0.2.5))
executable: /Users/hirwa/Desktop/open/stimedev/bin/python
   machine: macOS-14.4.1-arm64-arm-64bit

Python dependencies:
          pip: 23.3.1
          sktime: 0.29.0
          sklearn: None
          skbase: None
          numpy: 1.26.4
          scipy: 1.13.0
          pandas: 2.1.4
          matplotlib: 3.8.4
          joblib: 1.4.0
          numba: 0.59.1
          statsmodels: 0.14.2
          pmdarima: 2.0.4
          statsforecast: 1.7.4
          tsfresh: 0.20.2
          tslearn: 0.6.3
          torch: 2.3.0
          tensorflow: 2.16.1
          tensorflow_probability: None
          ```
#### Suggest a potential alternative/fix
Fixing the notebook would solve the issue
<!--
Tell us how we could improve the documentation in this regard.
-->
@fnhirwa fnhirwa added the documentation Documentation & tutorials label May 15, 2024
fkiraly pushed a commit that referenced this issue May 16, 2024
Fixes #6425

#### What does this implement/fix? Explain your changes.
<!--
A clear and concise description of what you have implemented.
-->

This PR resolves the failure 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation & tutorials
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant