1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
"""
from: https://gist.github.com/mgedmin/6052926
Sphinx extension to add ReadTheDocs-style "Edit on GitHub" links to the
sidebar.
Loosely based on https://github.com/astropy/astropy/pull/347
"""
import os
import warnings
__license__ = "BSD (3 clause)"
def get_github_url(app, view, path):
return "https://github.com/{project}/{view}/{branch}/docs/reST/{path}".format(
project=app.config.edit_on_github_project,
view=view,
branch=app.config.edit_on_github_branch,
path=path,
)
def html_page_context(app, pagename, templatename, context, doctree):
if templatename != "page.html":
return
if not app.config.edit_on_github_project:
warnings.warn("edit_on_github_project not specified")
return
path = os.path.relpath(doctree.get("source"), app.builder.srcdir)
show_url = get_github_url(app, "blob", path)
edit_url = get_github_url(app, "edit", path)
context["show_on_github_url"] = show_url
context["edit_on_github_url"] = edit_url
def setup(app):
app.add_config_value("edit_on_github_project", "", True)
app.add_config_value("edit_on_github_branch", "main", True)
app.connect("html-page-context", html_page_context)
|
