:github_url: as a theme option

[eine]

I am trying to reproduce locally the output I get in RTD (see readthedocs-docker-images#47). According to the README here, it seems that I need to manually add :github_url: to each page in order to have 'Edit on GitHub' instead of 'View page source'. I would expect this option to be available as a theme option, so that the same sources produce the same result in RTD and locally.

[jessetan]

You can reproduce this locally by changing your conf.py:

html_context = {
  'display_github': True,
  'github_user': 'username',
  'github_repo': 'reponame',
  'github_version': 'master'
}

Related to #156.

[eine]

@jessetan Thanks a lot. That's exactly what I needed. However, I had to slightly modify it:

'display_github': True,
'github_user': 'username',
'github_repo': 'reponame',
'github_version': 'branch/doc/'

Note the subdir after the branch/version, and the trailing slash.

I close this, because the question is solved. But you might want to reopen it to keep track of the pending documentation.

[Blendify]

This is a duplicate of #465

[peterjc]

You don't need to have a slash in github_version, see example here:

#231 (comment)

I'll add a comment on #465.