Skip to content

Commit 993b57b

Browse files
mitya57waylan
authored andcommitted
Fixed links to source code on GitHub from the documentation
With the current version, if you open e.g. this page: https://python-markdown.github.io/reference/markdown/blockprocessors/ The ‹› links on the right side of the page will point to URLs like https://github.com/Python-Markdown/markdown/tree/3.6//home/runner/work/markdown/markdown/md/markdown/blockprocessors.py This commit fixes them by replacing `filepath` with `relative_filepath`.
1 parent e524b8f commit 993b57b

File tree

5 files changed

+10
-4
lines changed

5 files changed

+10
-4
lines changed

docs/changelog.md

+6
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ All notable changes to this project will be documented in this file.
88
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
99
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). See the [Contributing Guide](contributing.md) for details.
1010

11+
## [unreleased]
12+
13+
### Fixed
14+
15+
* Fixed links to source code on GitHub from the documentation (#1453).
16+
1117
## [3.6] -- 2024-03-14
1218

1319
### Changed

docs/templates/python/nature/attribute.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{% extends "_base/attribute.html" %}
22

33
{% block heading scoped %}
4-
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ attribute.filepath }}#L{{ attribute.lineno }}{% if attribute.endlineno > attribute.lineno %}-L{{ attribute.endlineno }}{% endif %}" title='View source code on GitHub'>&lsaquo;&rsaquo;</a>
4+
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ attribute.relative_filepath }}#L{{ attribute.lineno }}{% if attribute.endlineno > attribute.lineno %}-L{{ attribute.endlineno }}{% endif %}" title='View source code on GitHub'>&lsaquo;&rsaquo;</a>
55
{% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code>{% endif %}
66
{%+ filter highlight(language="python", inline=True) %}
77
{{ attribute_name }}{% if attribute.annotation %}: {{ attribute.annotation }}{% endif %}
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{% extends "_base/class.html" %}
22

33
{% block heading scoped %}
4-
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ class.filepath }}#L{{ class.lineno }}" title="{{ config.source.title }}">&lsaquo;&rsaquo;</a>
4+
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ class.relative_filepath }}#L{{ class.lineno }}" title="{{ config.source.title }}">&lsaquo;&rsaquo;</a>
55
{{ super() }}
66
{% endblock heading %}
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{% extends "_base/function.html" %}
22

33
{% block heading scoped %}
4-
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ function.filepath }}#L{{ function.lineno }}{% if function.endlineno > function.lineno %}-L{{ function.endlineno }}{% endif %}" title="{{ config.source.title }}">&lsaquo;&rsaquo;</a>
4+
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ function.relative_filepath }}#L{{ function.lineno }}{% if function.endlineno > function.lineno %}-L{{ function.endlineno }}{% endif %}" title="{{ config.source.title }}">&lsaquo;&rsaquo;</a>
55
{{ super() }}
66
{% endblock heading %}
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{% extends "_base/module.html" %}
22

33
{% block heading scoped %}
4-
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ module.filepath }}" title="{{ config.source.title }}">&lsaquo;&rsaquo;</a>
4+
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ module.relative_filepath }}" title="{{ config.source.title }}">&lsaquo;&rsaquo;</a>
55
{{ super() }}
66
{% endblock heading %}

0 commit comments

Comments
 (0)