Lines Matching +full:url +full:- +full:base
8 SPDX-License-Identifier: Apache-2.0
20 * ``gh_link_get_blob_url``: Returns a URL to the source of a page on GitHub.
21 * ``gh_link_get_edit_url``: Returns a URL to edit the given page on GitHub.
22 * ``gh_link_get_open_issue_url``: Returns a URL to open a new issue regarding the given page.
29 - ``gh_link_version``: GitHub version to use in the URL (e.g. "main")
30 - ``gh_link_base_url``: Base URL used as a prefix for generated URLs.
31 - ``gh_link_prefixes``: Mapping of pages (regex) <> GitHub prefix.
32 - ``gh_link_exclude``: List of pages (regex) that will not report a URL. Useful
33 for, e.g., auto-generated pages not in Git.
61 def get_page_prefix(app: Sphinx, pagename: str) -> str:
92 def gh_link_get_url(app: Sphinx, pagename: str, mode: str = "blob") -> str | None:
93 """Obtain GitHub URL for the given page.
101 GitHub URL if applicable, None otherwise.
119 def gh_link_get_open_issue_url(app: Sphinx, pagename: str, sha1: str) -> str | None:
121 labels already pre-filled with useful information.
128 URL to open a new issue if applicable, None otherwise.
158 * SHA-1: {sha1}
166 def git_info_filter(app: Sphinx, pagename) -> tuple[str, str] | None:
170 app {Sphinx} -- Sphinx application object
171 pagename {str} -- Page name
174 Optional[Tuple[str, str]] -- Tuple with the date and SHA1 of the last commit made to the
192 ["git", "ls-files", "--error-unmatch", orig_path],
204 "-1",
205 "--format=%ad %H",
206 "--date=unix",
211 .decode("utf-8")
249 app.connect("builder-inited", add_jinja_filter)