Links to python scripts and notebooks throughout the docs are broken
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.6k
- Forks
- 440
- PR merge metrics
- No merged PRs in 30d
Description
For example, in the first tutorial:
At the bottom, there is the sentence:
"Well, that’s it for this example. You’ll find the full, unadulterated sample code for this demo here."
But the "here" is broken.
Likewise, in this git repo, the links to all the ipython notebooks in the tutorials are broken.
For example, in this tutorial:
https://github.com/dfm/emcee/blob/master/docs/tutorials/autocorr.rst
It begins with the sentence:
"Note: This tutorial was generated from an IPython notebook that can be downloaded here."
But the link does not work.
Thanks for the nice package by the way.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the links in the first tutorial and docs/tutorials/autocorr.rst, including references to examples/quickstart.py and _static/notebooks/autocorr.ipynb. Check the repository paths and documentation build output, then update the broken references throughout the docs so each script and notebook link resolves successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100