Based on #231 (comment) from @IKavanagh (thank you!), you can do the following in your conf.py file:

html_context = {
  "display_github": True, # Add 'Edit on Github' link instead of 'View page source'
  "github_user": "peterjc",
  "github_repo": project,  # assuming an exact match
  "github_version": "master",
  "conf_py_path": "/doc/", # needs leading and trailing slashes!
  # "source_suffix": source_suffix,
}

I've not explored why conf_py_path is called that, but it seems to be the relative path from the GitHub repository root to your documentation folder (where conf.py lives etc), and it needs leading and trailing slashes.

I have not needed to set source_suffix myself yet.

e.g. peterjc/thapbi-pict@9ec5300

If you need to over-ride this in any particular *.rst files, for example automatically generated ones which are not in GitHub, they need a line like the following added at the start:

:github_url: https://github.com/peterjc/...

e.g. peterjc/thapbi-pict@f14b1df does this via a function in conf.py

Customization options for bitbucket, gitlab, and github are undocumented #465

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions