Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Github edit links in top-right of HTML pages #170

Merged
merged 2 commits into from
Nov 3, 2023

Conversation

awelzel
Copy link
Contributor

@awelzel awelzel commented Nov 3, 2023

These links 404'd because they omitted the file suffix, and they didn't really link to anything editable, just the raw file.


In this case, "suffix" was used which is set by the readthedocs theme in older versions [1]. Seem good to replace with page_source_suffix.

Relates to zeek/zeek-docs#222

[1] readthedocs/sphinx_rtd_theme#1104

ckreibich and others added 2 commits November 3, 2023 10:26
These links 404'd because they omitted the file suffix, and they didn't really
link to anything editable, just the raw file.

---

In this case, "suffix" was used which is set by the readthedocs theme in
older versions [1]. Seem good to replace with page_source_suffix.

[1] readthedocs/sphinx_rtd_theme#1104
@awelzel awelzel requested a review from bbannier November 3, 2023 09:45
Copy link
Member

@bbannier bbannier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, this is consistent with the Zeek change.

Do you want to fix the build against zeek-dev in this PR or will you create a follow-up issue?

@awelzel
Copy link
Contributor Author

awelzel commented Nov 3, 2023

LGTM, this is consistent with the Zeek change.
Do you want to fix the build against zeek-dev in this PR or will you create a follow-up issue?

Thanks - I'll merge just the docs change with a broken pipeline. There's more to that failing test than just a simple baseline/exec update 😢

@awelzel awelzel merged commit 6b73b15 into master Nov 3, 2023
3 of 5 checks passed
@awelzel awelzel deleted the topic/awelzel/fix-github-edit-link branch November 3, 2023 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants