sktime/sktime

[BUG] some user guide notebooks are not properly displayed

Open

#3,246 opened on Aug 11, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (7,162 stars) (1,192 forks)batch import
bugdocumentationgood first issue

Description

The symbolic links for some of the user guide notebooks do not seem to work, see here:

https://www.sktime.org/en/latest/user_guide.html

Not quite sure what the issue is, seemed fine in the preview.

An issue might be that I did this manually instead of via using the docs/symlink_examples.sh utility - perhaps the fix is as easy as running the utility and making a pull request with the changes?

Someone with a Mac or Unix OS would have to do that though.

Good first issue, since we should try running symlink_examples and see what happens (that sounds easy with the right OS).

Contributor guide

Tech stack
pythonshell
Domain
documentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Unix or Mac OSbasic command line
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Run the 'docs/symlink examples.sh' script from a Unix/Mac environment to regenerate symbolic links for user guide notebooks. Check if the notebooks are correctly linked in the documentation build. If the script fails or produces incorrect results, investigate the link structure in the 'docs/' directory. Refer to the issue comments for any additional context.