dfm / dfm/emcee

Links to python scripts and notebooks throughout the docs are broken

Open
#281 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Bug Documentation
Dominant language
Python
Stars
1.6k
Forks
440
PR merge metrics
No merged PRs in 30d

Description

For example, in the first tutorial:

https://emcee.readthedocs.io/en/stable/user/quickstart.html#how-to-sample-a-multi-dimensional-gaussian

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.