Bad Doc Link: Pitch Basics page

khoffLSU commented 5 months ago

The edit on GitHub link on the page for Pitch Basics returns a 404 - Page not found error. The Link is on the top right of the page.

Here is the link to the docs page

khoffLSU commented 5 months ago

This appears to be the correct file location on the repo: examples/pitch_setup/plot_pitches.py

Link to repo location

khoffLSU commented 5 months ago

@andrewRowlinson, what version of Sphinx-rtd are you running to set up the project? I found some details around modifying the information in the conf.py file for html_context, but I did not see this anywhere in the current file. The issue seems to be happening on all the pages but the index.rst which is still located under the docs directory for the project. The rest of the pages are under the examples directory.

html_context = {
    'source_url_prefix': "https://gitlab.com/username/repo/blob/version/doc/",
    "display_github": True,
    "github_host": "github.com",
    "github_user": "username",
    "github_repo": 'reponame',
    "github_version": "version",
    "conf_py_path": "/doc/",
    "source_suffix": '.rst',
}

andrewRowlinson commented 5 months ago

I've never noticed that link before. That's because I don't store the built docs on GitHub so there is nothing to edit. The versions I use are here: https://github.com/andrewRowlinson/mplsoccer/blob/main/environment-docs.yml

andrewRowlinson / mplsoccer

Bad Doc Link: Pitch Basics page #103