edit-this-page.html

{%- macro sanitise_trailing_slash(s) -%}{{ s.rstrip("/") }}{%- endmacro -%}

{%- macro determine_page_edit_link() -%}
  {%- if theme_source_edit_link -%}
    {{ theme_source_edit_link.format(filename=pagename+page_source_suffix) }}
  {%- else -%}
    {#- First, sanitise the trailing slashes. -#}
    {%- set repo = sanitise_trailing_slash(theme_source_repository) -%}
    {%- set branch = theme_source_branch -%}
    {%- set subdirectory = sanitise_trailing_slash(theme_source_directory) -%}

    {#- Figure out the document's source file path. -#}
    {%- set relative_path = pagename + page_source_suffix -%}
    {%- if not subdirectory -%}
      {%- set document_path = relative_path -%}
    {%- else -%}
      {%- set document_path = subdirectory + "/" + relative_path -%}
    {%- endif -%}

    {#- Don't allow http:// URLs -#}
    {%- if repo.startswith(
      (
        "http://github.com/",
        "http://gitlab.com/",
        "http://bitbucket.org/",
      )
    ) -%}
      {{ warning("Could not use `source_repository` provided. Please use https:// links in your `conf.py` file's `html_theme_options`.") }}
    {#- Handle the relevant cases -#}
    {%- elif repo.startswith("https://github.com/") -%}
      {{ repo }}/edit/{{ branch }}/{{ document_path }}
    {%- elif repo.startswith("https://gitlab.com/") -%}
      {{ repo }}/-/edit/{{ branch }}/{{ document_path }}
    {%- elif repo.startswith("https://bitbucket.org/") -%}
      {{ repo }}/src/{{ branch }}/{{ document_path }}?mode=edit&at={{ branch }}
    {#- Fail with a warning -#}
    {%- else -%}
      {{ warning(
        "Could not understand `source_repository` provided: " + repo + "\n" +
        "You should set `source_edit_link`, so that the edit link is presented."
      ) }}
    {%- endif -%}
  {%- endif -%}
{%- endmacro -%}


{%- if page_source_suffix -%}
  {%- set can_find_edit_link = (
    (theme_source_edit_link and pagename)
    or (theme_source_repository and theme_source_branch)
  ) -%}
  {%- if can_find_edit_link -%}
    {%- block link_available -%}
    <a href="{{ determine_page_edit_link() }}">{{ _("Edit this page") }}</a>
    {%- endblock link_available -%}
  {%- else -%}
    {%- block link_not_available -%}{%- endblock -%}
  {%- endif -%}
{%- endif -%}