Edit on GitHub button does not work in documentation (stable)

[krassowski]

When on https://jupyterlab.readthedocs.io/en/stable/# the Edit on GitHub button goes to https://github.com/jupyterlab/jupyterlab/blob/origin/3.x/docs/source/index.rst which does not exist; the origin part is spurrious, the correct URL would be: https://github.com/jupyterlab/jupyterlab/blob/3.x/docs/source/index.rst.

Probably trivial to fix, but opening the issue anyways, i.e. how could we make sure that it works in the future. Would it be worth to set up an automated check for dead links in documentation?

[krassowski]

the latest tag works ok. It seems that the url is configured in RTD because the version in conf.py is set to master on 3.x:

jupyterlab/docs/source/conf.py

Line 174 in dbcfeef

"github_version": "master", # Version

So it must be using the github_url from meta instead:

jupyterlab/docs/source/_templates/breadcrumbs.html

Lines 14 to 19 in d8d6f91

	{% if check_meta and 'github_url' in meta %}
	<!-- User defined GitHub URL -->
	<a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
	{% else %}
	<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
	{% endif %}

but this is not appearing in the code anywhere else so I assume it is somehow set by RTD.

[jasongrout]

Is that what these lines are doing?

jupyterlab/docs/source/conf.py

Lines 64 to 78 in ae9300a

	# The version info for the project you're documenting, acts as replacement for
	# |version| and |release|, also used in various other places throughout the
	# built documents.
	import os
	_version_py = os.path.join('..', '..', 'jupyterlab', '_version.py')
	version_ns = {}
	with open(_version_py, mode='r') as version_file:
	exec(version_file.read(), version_ns)
	# The short X.Y version.
	version = '%i.%i' % version_ns['version_info'][:2]
	# The full version, including alpha/beta/rc tags.
	release = version_ns['__version__']

[krassowski]

I don't think so. It seems to be related to readthedocs/readthedocs.org#1637

[whurd-redcanary]

I don't think so. It seems to be related to readthedocs/readthedocs.org#1637

It looks as if you need to update the version of sphinx running https://jupyterlab.readthedocs.io/ ?

sfstoolbox/sfs-python#48

[krassowski]

I just confirmed that the workaround in #11149 fixed both the links on stable and latest versions (latest stopped working recently), closing.