Skip to content

Set edit links dynamically for RtD preview and PR builds #3280

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.

Sign up for GitHub

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

Open
mnocon wants to merge 1 commit into
base: 5.0
Choose a base branch
from
Open

Set edit links dynamically for RtD preview and PR builds #3280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/vendor/
**/.DS_Store
__pycache__/*
hooks/__pycache__/*
/site/
**/.idea/
.php-cs-fixer.cache
Expand Down
12 changes: 12 additions & 0 deletions hooks/edit_uri.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import os

def on_config(config, **kwargs):
if os.environ.get("READTHEDOCS_VERSION_TYPE") == "external":
ref = os.environ.get("READTHEDOCS_GIT_COMMIT_HASH")
else:
ref = os.environ.get("GITHUB_HEAD_REF")

if ref:
config["edit_uri"] = f"edit/{ref}/docs/"

return config
2 changes: 2 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ site_name: Developer Documentation
repo_url: https://github.com/ibexa/documentation-developer
edit_uri: edit/5.0/docs
site_url: https://doc.ibexa.co/en/latest/
hooks:
- hooks/edit_uri.py
copyright: "Copyright 1999-2026 Ibexa AS and others"
validation:
omitted_files: warn
Expand Down
Loading